<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.configuration;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.io.File;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.net.URL;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.ArrayList;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.Collections;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.util.HashMap;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.Iterator;<a name="line.24"></a>
<FONT color="green">025</FONT>    import java.util.List;<a name="line.25"></a>
<FONT color="green">026</FONT>    import java.util.Map;<a name="line.26"></a>
<FONT color="green">027</FONT>    <a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.commons.configuration.beanutils.BeanDeclaration;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.commons.configuration.beanutils.BeanFactory;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.commons.configuration.beanutils.BeanHelper;<a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.commons.configuration.beanutils.DefaultBeanFactory;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.commons.configuration.beanutils.XMLBeanDeclaration;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.commons.configuration.event.ConfigurationErrorListener;<a name="line.33"></a>
<FONT color="green">034</FONT>    import org.apache.commons.configuration.event.ConfigurationListener;<a name="line.34"></a>
<FONT color="green">035</FONT>    import org.apache.commons.configuration.interpol.ConfigurationInterpolator;<a name="line.35"></a>
<FONT color="green">036</FONT>    import org.apache.commons.configuration.resolver.CatalogResolver;<a name="line.36"></a>
<FONT color="green">037</FONT>    import org.apache.commons.configuration.resolver.EntityRegistry;<a name="line.37"></a>
<FONT color="green">038</FONT>    import org.apache.commons.configuration.resolver.EntityResolverSupport;<a name="line.38"></a>
<FONT color="green">039</FONT>    import org.apache.commons.configuration.tree.ConfigurationNode;<a name="line.39"></a>
<FONT color="green">040</FONT>    import org.apache.commons.configuration.tree.DefaultExpressionEngine;<a name="line.40"></a>
<FONT color="green">041</FONT>    import org.apache.commons.configuration.tree.OverrideCombiner;<a name="line.41"></a>
<FONT color="green">042</FONT>    import org.apache.commons.configuration.tree.UnionCombiner;<a name="line.42"></a>
<FONT color="green">043</FONT>    import org.apache.commons.lang.text.StrLookup;<a name="line.43"></a>
<FONT color="green">044</FONT>    import org.apache.commons.logging.Log;<a name="line.44"></a>
<FONT color="green">045</FONT>    import org.apache.commons.logging.LogFactory;<a name="line.45"></a>
<FONT color="green">046</FONT>    import org.xml.sax.EntityResolver;<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>    /**<a name="line.48"></a>
<FONT color="green">049</FONT>     * &lt;p&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>     * A factory class that creates a composite configuration from an XML based<a name="line.50"></a>
<FONT color="green">051</FONT>     * &lt;em&gt;configuration definition file&lt;/em&gt;.<a name="line.51"></a>
<FONT color="green">052</FONT>     * &lt;/p&gt;<a name="line.52"></a>
<FONT color="green">053</FONT>     * &lt;p&gt;<a name="line.53"></a>
<FONT color="green">054</FONT>     * This class provides an easy and flexible means for loading multiple<a name="line.54"></a>
<FONT color="green">055</FONT>     * configuration sources and combining the results into a single configuration<a name="line.55"></a>
<FONT color="green">056</FONT>     * object. The sources to be loaded are defined in an XML document that can<a name="line.56"></a>
<FONT color="green">057</FONT>     * contain certain tags representing the different supported configuration<a name="line.57"></a>
<FONT color="green">058</FONT>     * classes. If such a tag is found, the corresponding {@code Configuration}<a name="line.58"></a>
<FONT color="green">059</FONT>     * class is instantiated and initialized using the classes of the<a name="line.59"></a>
<FONT color="green">060</FONT>     * {@code beanutils} package (namely<a name="line.60"></a>
<FONT color="green">061</FONT>     * {@link org.apache.commons.configuration.beanutils.XMLBeanDeclaration XMLBeanDeclaration}<a name="line.61"></a>
<FONT color="green">062</FONT>     * will be used to extract the configuration's initialization parameters, which<a name="line.62"></a>
<FONT color="green">063</FONT>     * allows for complex initialization scenarios).<a name="line.63"></a>
<FONT color="green">064</FONT>     * &lt;/p&gt;<a name="line.64"></a>
<FONT color="green">065</FONT>     * &lt;p&gt;<a name="line.65"></a>
<FONT color="green">066</FONT>     * It is also possible to add custom tags to the configuration definition file.<a name="line.66"></a>
<FONT color="green">067</FONT>     * For this purpose register your own {@code ConfigurationProvider}<a name="line.67"></a>
<FONT color="green">068</FONT>     * implementation for your tag using the {@code addConfigurationProvider()}<a name="line.68"></a>
<FONT color="green">069</FONT>     * method. This provider will then be called when the corresponding custom tag<a name="line.69"></a>
<FONT color="green">070</FONT>     * is detected. For the default configuration classes providers are already<a name="line.70"></a>
<FONT color="green">071</FONT>     * registered.<a name="line.71"></a>
<FONT color="green">072</FONT>     * &lt;/p&gt;<a name="line.72"></a>
<FONT color="green">073</FONT>     * &lt;p&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     * The configuration definition file has the following basic structure:<a name="line.74"></a>
<FONT color="green">075</FONT>     * &lt;/p&gt;<a name="line.75"></a>
<FONT color="green">076</FONT>     * &lt;p&gt;<a name="line.76"></a>
<FONT color="green">077</FONT>     *<a name="line.77"></a>
<FONT color="green">078</FONT>     * &lt;pre&gt;<a name="line.78"></a>
<FONT color="green">079</FONT>     * &amp;lt;configuration systemProperties="properties file name"&amp;gt;<a name="line.79"></a>
<FONT color="green">080</FONT>     *   &amp;lt;header&amp;gt;<a name="line.80"></a>
<FONT color="green">081</FONT>     *     &amp;lt;!-- Optional meta information about the composite configuration --&amp;gt;<a name="line.81"></a>
<FONT color="green">082</FONT>     *   &amp;lt;/header&amp;gt;<a name="line.82"></a>
<FONT color="green">083</FONT>     *   &amp;lt;override&amp;gt;<a name="line.83"></a>
<FONT color="green">084</FONT>     *     &amp;lt;!-- Declarations for override configurations --&amp;gt;<a name="line.84"></a>
<FONT color="green">085</FONT>     *   &amp;lt;/override&amp;gt;<a name="line.85"></a>
<FONT color="green">086</FONT>     *   &amp;lt;additional&amp;gt;<a name="line.86"></a>
<FONT color="green">087</FONT>     *     &amp;lt;!-- Declarations for union configurations --&amp;gt;<a name="line.87"></a>
<FONT color="green">088</FONT>     *   &amp;lt;/additional&amp;gt;<a name="line.88"></a>
<FONT color="green">089</FONT>     * &amp;lt;/configuration&amp;gt;<a name="line.89"></a>
<FONT color="green">090</FONT>     * &lt;/pre&gt;<a name="line.90"></a>
<FONT color="green">091</FONT>     *<a name="line.91"></a>
<FONT color="green">092</FONT>     * &lt;/p&gt;<a name="line.92"></a>
<FONT color="green">093</FONT>     * &lt;p&gt;<a name="line.93"></a>
<FONT color="green">094</FONT>     * The name of the root element (here {@code configuration}) is<a name="line.94"></a>
<FONT color="green">095</FONT>     * arbitrary. The optional systemProperties attribute identifies the path to<a name="line.95"></a>
<FONT color="green">096</FONT>     * a property file containing properties that should be added to the system<a name="line.96"></a>
<FONT color="green">097</FONT>     * properties. If specified on the root element, the system properties are<a name="line.97"></a>
<FONT color="green">098</FONT>     * set before the rest of the configuration is processed.<a name="line.98"></a>
<FONT color="green">099</FONT>     * &lt;/p&gt;<a name="line.99"></a>
<FONT color="green">100</FONT>     * &lt;p&gt;<a name="line.100"></a>
<FONT color="green">101</FONT>     * There are two sections (both of them are optional) for declaring<a name="line.101"></a>
<FONT color="green">102</FONT>     * &lt;em&gt;override&lt;/em&gt; and &lt;em&gt;additional&lt;/em&gt; configurations. Configurations<a name="line.102"></a>
<FONT color="green">103</FONT>     * in the former section are evaluated in the order of their declaration, and<a name="line.103"></a>
<FONT color="green">104</FONT>     * properties of configurations declared earlier hide those of configurations<a name="line.104"></a>
<FONT color="green">105</FONT>     * declared later. Configurations in the latter section are combined to a union<a name="line.105"></a>
<FONT color="green">106</FONT>     * configuration, i.e. all of their properties are added to a large hierarchical<a name="line.106"></a>
<FONT color="green">107</FONT>     * configuration. Configuration declarations that occur as direct children of<a name="line.107"></a>
<FONT color="green">108</FONT>     * the root element are treated as override declarations.<a name="line.108"></a>
<FONT color="green">109</FONT>     * &lt;/p&gt;<a name="line.109"></a>
<FONT color="green">110</FONT>     * &lt;p&gt;<a name="line.110"></a>
<FONT color="green">111</FONT>     * Each configuration declaration consists of a tag whose name is associated<a name="line.111"></a>
<FONT color="green">112</FONT>     * with a {@code ConfigurationProvider}. This can be one of the<a name="line.112"></a>
<FONT color="green">113</FONT>     * predefined tags like {@code properties}, or {@code xml}, or<a name="line.113"></a>
<FONT color="green">114</FONT>     * a custom tag, for which a configuration provider was registered. Attributes<a name="line.114"></a>
<FONT color="green">115</FONT>     * and sub elements with specific initialization parameters can be added. There<a name="line.115"></a>
<FONT color="green">116</FONT>     * are some reserved attributes with a special meaning that can be used in every<a name="line.116"></a>
<FONT color="green">117</FONT>     * configuration declaration:<a name="line.117"></a>
<FONT color="green">118</FONT>     * &lt;/p&gt;<a name="line.118"></a>
<FONT color="green">119</FONT>     * &lt;p&gt;<a name="line.119"></a>
<FONT color="green">120</FONT>     * &lt;table border="1"&gt;<a name="line.120"></a>
<FONT color="green">121</FONT>     * &lt;tr&gt;<a name="line.121"></a>
<FONT color="green">122</FONT>     * &lt;th&gt;Attribute&lt;/th&gt;<a name="line.122"></a>
<FONT color="green">123</FONT>     * &lt;th&gt;Meaning&lt;/th&gt;<a name="line.123"></a>
<FONT color="green">124</FONT>     * &lt;/tr&gt;<a name="line.124"></a>
<FONT color="green">125</FONT>     * &lt;tr&gt;<a name="line.125"></a>
<FONT color="green">126</FONT>     * &lt;td valign="top"&gt;{@code config-name}&lt;/td&gt;<a name="line.126"></a>
<FONT color="green">127</FONT>     * &lt;td&gt;Allows to specify a name for this configuration. This name can be used<a name="line.127"></a>
<FONT color="green">128</FONT>     * to obtain a reference to the configuration from the resulting combined<a name="line.128"></a>
<FONT color="green">129</FONT>     * configuration (see below).&lt;/td&gt;<a name="line.129"></a>
<FONT color="green">130</FONT>     * &lt;/tr&gt;<a name="line.130"></a>
<FONT color="green">131</FONT>     * &lt;tr&gt;<a name="line.131"></a>
<FONT color="green">132</FONT>     * &lt;td valign="top"&gt;{@code config-at}&lt;/td&gt;<a name="line.132"></a>
<FONT color="green">133</FONT>     * &lt;td&gt;With this attribute an optional prefix can be specified for the<a name="line.133"></a>
<FONT color="green">134</FONT>     * properties of the corresponding configuration.&lt;/td&gt;<a name="line.134"></a>
<FONT color="green">135</FONT>     * &lt;/tr&gt;<a name="line.135"></a>
<FONT color="green">136</FONT>     * &lt;tr&gt;<a name="line.136"></a>
<FONT color="green">137</FONT>     * &lt;td valign="top"&gt;{@code config-optional}&lt;/td&gt;<a name="line.137"></a>
<FONT color="green">138</FONT>     * &lt;td&gt;Declares a configuration as optional. This means that errors that occur<a name="line.138"></a>
<FONT color="green">139</FONT>     * when creating the configuration are ignored. (However<a name="line.139"></a>
<FONT color="green">140</FONT>     * {@link org.apache.commons.configuration.event.ConfigurationErrorListener}s<a name="line.140"></a>
<FONT color="green">141</FONT>     * registered at the builder instance will get notified about this error: they<a name="line.141"></a>
<FONT color="green">142</FONT>     * receive an event of type {@code EVENT_ERR_LOAD_OPTIONAL}. The key<a name="line.142"></a>
<FONT color="green">143</FONT>     * property of this event contains the name of the optional configuration source<a name="line.143"></a>
<FONT color="green">144</FONT>     * that caused this problem.)&lt;/td&gt;<a name="line.144"></a>
<FONT color="green">145</FONT>     * &lt;/tr&gt;<a name="line.145"></a>
<FONT color="green">146</FONT>     * &lt;/table&gt;<a name="line.146"></a>
<FONT color="green">147</FONT>     * &lt;/p&gt;<a name="line.147"></a>
<FONT color="green">148</FONT>     * &lt;p&gt;<a name="line.148"></a>
<FONT color="green">149</FONT>     * The optional &lt;em&gt;header&lt;/em&gt; section can contain some meta data about the<a name="line.149"></a>
<FONT color="green">150</FONT>     * created configuration itself. For instance, it is possible to set further<a name="line.150"></a>
<FONT color="green">151</FONT>     * properties of the {@code NodeCombiner} objects used for constructing<a name="line.151"></a>
<FONT color="green">152</FONT>     * the resulting configuration.<a name="line.152"></a>
<FONT color="green">153</FONT>     * &lt;/p&gt;<a name="line.153"></a>
<FONT color="green">154</FONT>     * &lt;p&gt;<a name="line.154"></a>
<FONT color="green">155</FONT>     * The default configuration object returned by this builder is an instance of the<a name="line.155"></a>
<FONT color="green">156</FONT>     * {@link CombinedConfiguration} class. The return value of the<a name="line.156"></a>
<FONT color="green">157</FONT>     * {@code getConfiguration()} method can be casted to this type, and the<a name="line.157"></a>
<FONT color="green">158</FONT>     * {@code getConfiguration(boolean)} method directly declares<a name="line.158"></a>
<FONT color="green">159</FONT>     * {@code CombinedConfiguration} as return type. This allows for<a name="line.159"></a>
<FONT color="green">160</FONT>     * convenient access to the configuration objects maintained by the combined<a name="line.160"></a>
<FONT color="green">161</FONT>     * configuration (e.g. for updates of single configuration objects). It has also<a name="line.161"></a>
<FONT color="green">162</FONT>     * the advantage that the properties stored in all declared configuration<a name="line.162"></a>
<FONT color="green">163</FONT>     * objects are collected and transformed into a single hierarchical structure,<a name="line.163"></a>
<FONT color="green">164</FONT>     * which can be accessed using different expression engines. The actual CombinedConfiguration<a name="line.164"></a>
<FONT color="green">165</FONT>     * implementation can be overridden by specifying the class in the &lt;em&gt;config-class&lt;/em&gt;<a name="line.165"></a>
<FONT color="green">166</FONT>     * attribute of the result element.<a name="line.166"></a>
<FONT color="green">167</FONT>     * &lt;/p&gt;<a name="line.167"></a>
<FONT color="green">168</FONT>     * &lt;p&gt;<a name="line.168"></a>
<FONT color="green">169</FONT>     * A custom EntityResolver can be used for all XMLConfigurations by adding<a name="line.169"></a>
<FONT color="green">170</FONT>     * &lt;pre&gt;<a name="line.170"></a>
<FONT color="green">171</FONT>     * &amp;lt;entity-resolver config-class="EntityResolver fully qualified class name"&amp;gt;<a name="line.171"></a>
<FONT color="green">172</FONT>     * &lt;/pre&gt;<a name="line.172"></a>
<FONT color="green">173</FONT>     * The CatalogResolver can be used for all XMLConfiguration by adding<a name="line.173"></a>
<FONT color="green">174</FONT>     * &lt;pre&gt;<a name="line.174"></a>
<FONT color="green">175</FONT>     * &amp;lt;entity-resolver catalogFiles="comma separated list of catalog files"&amp;gt;<a name="line.175"></a>
<FONT color="green">176</FONT>     * &lt;/pre&gt;<a name="line.176"></a>
<FONT color="green">177</FONT>     * &lt;/p&gt;<a name="line.177"></a>
<FONT color="green">178</FONT>     * &lt;p&gt;<a name="line.178"></a>
<FONT color="green">179</FONT>     * Additional ConfigurationProviders can be added by configuring them in the &lt;em&gt;header&lt;/em&gt;<a name="line.179"></a>
<FONT color="green">180</FONT>     * section.<a name="line.180"></a>
<FONT color="green">181</FONT>     * &lt;pre&gt;<a name="line.181"></a>
<FONT color="green">182</FONT>     * &amp;lt;providers&amp;gt;<a name="line.182"></a>
<FONT color="green">183</FONT>     *   &amp;lt;provider config-tag="tag name" config-class="provider fully qualified class name"/&amp;gt;<a name="line.183"></a>
<FONT color="green">184</FONT>     * &amp;lt;/providers&amp;gt;<a name="line.184"></a>
<FONT color="green">185</FONT>     * &lt;/pre&gt;<a name="line.185"></a>
<FONT color="green">186</FONT>     * &lt;/p&gt;<a name="line.186"></a>
<FONT color="green">187</FONT>     * &lt;p&gt;<a name="line.187"></a>
<FONT color="green">188</FONT>     * Additional variable resolvers can be added by configuring them in the &lt;em&gt;header&lt;/em&gt;<a name="line.188"></a>
<FONT color="green">189</FONT>     * section.<a name="line.189"></a>
<FONT color="green">190</FONT>     * &lt;pre&gt;<a name="line.190"></a>
<FONT color="green">191</FONT>     * &amp;lt;lookups&amp;gt;<a name="line.191"></a>
<FONT color="green">192</FONT>     *   &amp;lt;lookup config-prefix="prefix" config-class="StrLookup fully qualified class name"/&amp;gt;<a name="line.192"></a>
<FONT color="green">193</FONT>     * &amp;lt;/lookups&amp;gt;<a name="line.193"></a>
<FONT color="green">194</FONT>     * &lt;/pre&gt;<a name="line.194"></a>
<FONT color="green">195</FONT>     * &lt;/p&gt;<a name="line.195"></a>
<FONT color="green">196</FONT>     * &lt;p&gt;<a name="line.196"></a>
<FONT color="green">197</FONT>     * All declared override configurations are directly added to the resulting<a name="line.197"></a>
<FONT color="green">198</FONT>     * combined configuration. If they are given names (using the<a name="line.198"></a>
<FONT color="green">199</FONT>     * {@code config-name} attribute), they can directly be accessed using<a name="line.199"></a>
<FONT color="green">200</FONT>     * the {@code getConfiguration(String)} method of<a name="line.200"></a>
<FONT color="green">201</FONT>     * {@code CombinedConfiguration}. The additional configurations are<a name="line.201"></a>
<FONT color="green">202</FONT>     * altogether added to another combined configuration, which uses a union<a name="line.202"></a>
<FONT color="green">203</FONT>     * combiner. Then this union configuration is added to the resulting combined<a name="line.203"></a>
<FONT color="green">204</FONT>     * configuration under the name defined by the {@code ADDITIONAL_NAME}<a name="line.204"></a>
<FONT color="green">205</FONT>     * constant.<a name="line.205"></a>
<FONT color="green">206</FONT>     * &lt;/p&gt;<a name="line.206"></a>
<FONT color="green">207</FONT>     * &lt;p&gt;<a name="line.207"></a>
<FONT color="green">208</FONT>     * Implementation note: This class is not thread-safe. Especially the<a name="line.208"></a>
<FONT color="green">209</FONT>     * {@code getConfiguration()} methods should be called by a single thread<a name="line.209"></a>
<FONT color="green">210</FONT>     * only.<a name="line.210"></a>
<FONT color="green">211</FONT>     * &lt;/p&gt;<a name="line.211"></a>
<FONT color="green">212</FONT>     *<a name="line.212"></a>
<FONT color="green">213</FONT>     * @since 1.3<a name="line.213"></a>
<FONT color="green">214</FONT>     * @author &lt;a<a name="line.214"></a>
<FONT color="green">215</FONT>     * href="http://commons.apache.org/configuration/team-list.html"&gt;Commons<a name="line.215"></a>
<FONT color="green">216</FONT>     * Configuration team&lt;/a&gt;<a name="line.216"></a>
<FONT color="green">217</FONT>     * @version $Id: DefaultConfigurationBuilder.java 1366930 2012-07-29 20:05:36Z oheger $<a name="line.217"></a>
<FONT color="green">218</FONT>     */<a name="line.218"></a>
<FONT color="green">219</FONT>    public class DefaultConfigurationBuilder extends XMLConfiguration implements<a name="line.219"></a>
<FONT color="green">220</FONT>            ConfigurationBuilder<a name="line.220"></a>
<FONT color="green">221</FONT>    {<a name="line.221"></a>
<FONT color="green">222</FONT>        /**<a name="line.222"></a>
<FONT color="green">223</FONT>         * Constant for the name of the additional configuration. If the<a name="line.223"></a>
<FONT color="green">224</FONT>         * configuration definition file contains an {@code additional}<a name="line.224"></a>
<FONT color="green">225</FONT>         * section, a special union configuration is created and added under this<a name="line.225"></a>
<FONT color="green">226</FONT>         * name to the resulting combined configuration.<a name="line.226"></a>
<FONT color="green">227</FONT>         */<a name="line.227"></a>
<FONT color="green">228</FONT>        public static final String ADDITIONAL_NAME = DefaultConfigurationBuilder.class<a name="line.228"></a>
<FONT color="green">229</FONT>                .getName()<a name="line.229"></a>
<FONT color="green">230</FONT>                + "/ADDITIONAL_CONFIG";<a name="line.230"></a>
<FONT color="green">231</FONT>    <a name="line.231"></a>
<FONT color="green">232</FONT>        /**<a name="line.232"></a>
<FONT color="green">233</FONT>         * Constant for the type of error events caused by optional configurations<a name="line.233"></a>
<FONT color="green">234</FONT>         * that cannot be loaded.<a name="line.234"></a>
<FONT color="green">235</FONT>         */<a name="line.235"></a>
<FONT color="green">236</FONT>        public static final int EVENT_ERR_LOAD_OPTIONAL = 51;<a name="line.236"></a>
<FONT color="green">237</FONT>    <a name="line.237"></a>
<FONT color="green">238</FONT>        /** Constant for the name of the configuration bean factory. */<a name="line.238"></a>
<FONT color="green">239</FONT>        static final String CONFIG_BEAN_FACTORY_NAME = DefaultConfigurationBuilder.class<a name="line.239"></a>
<FONT color="green">240</FONT>                .getName()<a name="line.240"></a>
<FONT color="green">241</FONT>                + ".CONFIG_BEAN_FACTORY_NAME";<a name="line.241"></a>
<FONT color="green">242</FONT>    <a name="line.242"></a>
<FONT color="green">243</FONT>        /** Constant for the reserved name attribute. */<a name="line.243"></a>
<FONT color="green">244</FONT>        static final String ATTR_NAME = DefaultExpressionEngine.DEFAULT_ATTRIBUTE_START<a name="line.244"></a>
<FONT color="green">245</FONT>                + XMLBeanDeclaration.RESERVED_PREFIX<a name="line.245"></a>
<FONT color="green">246</FONT>                + "name"<a name="line.246"></a>
<FONT color="green">247</FONT>                + DefaultExpressionEngine.DEFAULT_ATTRIBUTE_END;<a name="line.247"></a>
<FONT color="green">248</FONT>    <a name="line.248"></a>
<FONT color="green">249</FONT>        /** Constant for the name of the at attribute. */<a name="line.249"></a>
<FONT color="green">250</FONT>        static final String ATTR_ATNAME = "at";<a name="line.250"></a>
<FONT color="green">251</FONT>    <a name="line.251"></a>
<FONT color="green">252</FONT>        /** Constant for the reserved at attribute. */<a name="line.252"></a>
<FONT color="green">253</FONT>        static final String ATTR_AT_RES = DefaultExpressionEngine.DEFAULT_ATTRIBUTE_START<a name="line.253"></a>
<FONT color="green">254</FONT>                + XMLBeanDeclaration.RESERVED_PREFIX<a name="line.254"></a>
<FONT color="green">255</FONT>                + ATTR_ATNAME<a name="line.255"></a>
<FONT color="green">256</FONT>                + DefaultExpressionEngine.DEFAULT_ATTRIBUTE_END;<a name="line.256"></a>
<FONT color="green">257</FONT>    <a name="line.257"></a>
<FONT color="green">258</FONT>        /** Constant for the at attribute without the reserved prefix. */<a name="line.258"></a>
<FONT color="green">259</FONT>        static final String ATTR_AT = DefaultExpressionEngine.DEFAULT_ATTRIBUTE_START<a name="line.259"></a>
<FONT color="green">260</FONT>                + ATTR_ATNAME + DefaultExpressionEngine.DEFAULT_ATTRIBUTE_END;<a name="line.260"></a>
<FONT color="green">261</FONT>    <a name="line.261"></a>
<FONT color="green">262</FONT>        /** Constant for the name of the optional attribute. */<a name="line.262"></a>
<FONT color="green">263</FONT>        static final String ATTR_OPTIONALNAME = "optional";<a name="line.263"></a>
<FONT color="green">264</FONT>    <a name="line.264"></a>
<FONT color="green">265</FONT>        /** Constant for the reserved optional attribute. */<a name="line.265"></a>
<FONT color="green">266</FONT>        static final String ATTR_OPTIONAL_RES = DefaultExpressionEngine.DEFAULT_ATTRIBUTE_START<a name="line.266"></a>
<FONT color="green">267</FONT>                + XMLBeanDeclaration.RESERVED_PREFIX<a name="line.267"></a>
<FONT color="green">268</FONT>                + ATTR_OPTIONALNAME<a name="line.268"></a>
<FONT color="green">269</FONT>                + DefaultExpressionEngine.DEFAULT_ATTRIBUTE_END;<a name="line.269"></a>
<FONT color="green">270</FONT>    <a name="line.270"></a>
<FONT color="green">271</FONT>        /** Constant for the optional attribute without the reserved prefix. */<a name="line.271"></a>
<FONT color="green">272</FONT>        static final String ATTR_OPTIONAL = DefaultExpressionEngine.DEFAULT_ATTRIBUTE_START<a name="line.272"></a>
<FONT color="green">273</FONT>                + ATTR_OPTIONALNAME + DefaultExpressionEngine.DEFAULT_ATTRIBUTE_END;<a name="line.273"></a>
<FONT color="green">274</FONT>    <a name="line.274"></a>
<FONT color="green">275</FONT>        /** Constant for the file name attribute. */<a name="line.275"></a>
<FONT color="green">276</FONT>        static final String ATTR_FILENAME = DefaultExpressionEngine.DEFAULT_ATTRIBUTE_START<a name="line.276"></a>
<FONT color="green">277</FONT>                + "fileName" + DefaultExpressionEngine.DEFAULT_ATTRIBUTE_END;<a name="line.277"></a>
<FONT color="green">278</FONT>    <a name="line.278"></a>
<FONT color="green">279</FONT>        /** Constant for the forceCreate attribute. */<a name="line.279"></a>
<FONT color="green">280</FONT>        static final String ATTR_FORCECREATE = DefaultExpressionEngine.DEFAULT_ATTRIBUTE_START<a name="line.280"></a>
<FONT color="green">281</FONT>                + XMLBeanDeclaration.RESERVED_PREFIX<a name="line.281"></a>
<FONT color="green">282</FONT>                + "forceCreate"<a name="line.282"></a>
<FONT color="green">283</FONT>                + DefaultExpressionEngine.DEFAULT_ATTRIBUTE_END;<a name="line.283"></a>
<FONT color="green">284</FONT>    <a name="line.284"></a>
<FONT color="green">285</FONT>        /**<a name="line.285"></a>
<FONT color="green">286</FONT>         * Constant for the tag attribute for providers.<a name="line.286"></a>
<FONT color="green">287</FONT>         */<a name="line.287"></a>
<FONT color="green">288</FONT>        static final String KEY_SYSTEM_PROPS = "[@systemProperties]";<a name="line.288"></a>
<FONT color="green">289</FONT>    <a name="line.289"></a>
<FONT color="green">290</FONT>        /** Constant for the name of the header section. */<a name="line.290"></a>
<FONT color="green">291</FONT>        static final String SEC_HEADER = "header";<a name="line.291"></a>
<FONT color="green">292</FONT>    <a name="line.292"></a>
<FONT color="green">293</FONT>        /** Constant for an expression that selects the union configurations. */<a name="line.293"></a>
<FONT color="green">294</FONT>        static final String KEY_UNION = "additional";<a name="line.294"></a>
<FONT color="green">295</FONT>    <a name="line.295"></a>
<FONT color="green">296</FONT>        /** An array with the names of top level configuration sections.*/<a name="line.296"></a>
<FONT color="green">297</FONT>        static final String[] CONFIG_SECTIONS = {<a name="line.297"></a>
<FONT color="green">298</FONT>            "additional", "override", SEC_HEADER<a name="line.298"></a>
<FONT color="green">299</FONT>        };<a name="line.299"></a>
<FONT color="green">300</FONT>    <a name="line.300"></a>
<FONT color="green">301</FONT>        /**<a name="line.301"></a>
<FONT color="green">302</FONT>         * Constant for an expression that selects override configurations in the<a name="line.302"></a>
<FONT color="green">303</FONT>         * override section.<a name="line.303"></a>
<FONT color="green">304</FONT>         */<a name="line.304"></a>
<FONT color="green">305</FONT>        static final String KEY_OVERRIDE = "override";<a name="line.305"></a>
<FONT color="green">306</FONT>    <a name="line.306"></a>
<FONT color="green">307</FONT>        /**<a name="line.307"></a>
<FONT color="green">308</FONT>         * Constant for the key that points to the list nodes definition of the<a name="line.308"></a>
<FONT color="green">309</FONT>         * override combiner.<a name="line.309"></a>
<FONT color="green">310</FONT>         */<a name="line.310"></a>
<FONT color="green">311</FONT>        static final String KEY_OVERRIDE_LIST = SEC_HEADER<a name="line.311"></a>
<FONT color="green">312</FONT>                + ".combiner.override.list-nodes.node";<a name="line.312"></a>
<FONT color="green">313</FONT>    <a name="line.313"></a>
<FONT color="green">314</FONT>        /**<a name="line.314"></a>
<FONT color="green">315</FONT>         * Constant for the key that points to the list nodes definition of the<a name="line.315"></a>
<FONT color="green">316</FONT>         * additional combiner.<a name="line.316"></a>
<FONT color="green">317</FONT>         */<a name="line.317"></a>
<FONT color="green">318</FONT>        static final String KEY_ADDITIONAL_LIST = SEC_HEADER<a name="line.318"></a>
<FONT color="green">319</FONT>                + ".combiner.additional.list-nodes.node";<a name="line.319"></a>
<FONT color="green">320</FONT>    <a name="line.320"></a>
<FONT color="green">321</FONT>        /**<a name="line.321"></a>
<FONT color="green">322</FONT>         * Constant for the key for defining providers in the configuration file.<a name="line.322"></a>
<FONT color="green">323</FONT>         */<a name="line.323"></a>
<FONT color="green">324</FONT>        static final String KEY_CONFIGURATION_PROVIDERS = SEC_HEADER<a name="line.324"></a>
<FONT color="green">325</FONT>                + ".providers.provider";<a name="line.325"></a>
<FONT color="green">326</FONT>    <a name="line.326"></a>
<FONT color="green">327</FONT>        /**<a name="line.327"></a>
<FONT color="green">328</FONT>         * Constant for the tag attribute for providers.<a name="line.328"></a>
<FONT color="green">329</FONT>         */<a name="line.329"></a>
<FONT color="green">330</FONT>        static final String KEY_PROVIDER_KEY = XMLBeanDeclaration.ATTR_PREFIX + "tag]";<a name="line.330"></a>
<FONT color="green">331</FONT>    <a name="line.331"></a>
<FONT color="green">332</FONT>        /**<a name="line.332"></a>
<FONT color="green">333</FONT>         * Constant for the key for defining variable resolvers<a name="line.333"></a>
<FONT color="green">334</FONT>         */<a name="line.334"></a>
<FONT color="green">335</FONT>        static final String KEY_CONFIGURATION_LOOKUPS = SEC_HEADER<a name="line.335"></a>
<FONT color="green">336</FONT>                + ".lookups.lookup";<a name="line.336"></a>
<FONT color="green">337</FONT>    <a name="line.337"></a>
<FONT color="green">338</FONT>        /**<a name="line.338"></a>
<FONT color="green">339</FONT>         * Constant for the key for defining entity resolvers<a name="line.339"></a>
<FONT color="green">340</FONT>         */<a name="line.340"></a>
<FONT color="green">341</FONT>        static final String KEY_ENTITY_RESOLVER = SEC_HEADER + ".entity-resolver";<a name="line.341"></a>
<FONT color="green">342</FONT>    <a name="line.342"></a>
<FONT color="green">343</FONT>        /**<a name="line.343"></a>
<FONT color="green">344</FONT>         * Constant for the prefix attribute for lookups.<a name="line.344"></a>
<FONT color="green">345</FONT>         */<a name="line.345"></a>
<FONT color="green">346</FONT>        static final String KEY_LOOKUP_KEY = XMLBeanDeclaration.ATTR_PREFIX + "prefix]";<a name="line.346"></a>
<FONT color="green">347</FONT>    <a name="line.347"></a>
<FONT color="green">348</FONT>        /**<a name="line.348"></a>
<FONT color="green">349</FONT>         * Constance for the FileSystem.<a name="line.349"></a>
<FONT color="green">350</FONT>         */<a name="line.350"></a>
<FONT color="green">351</FONT>        static final String FILE_SYSTEM = SEC_HEADER + ".fileSystem";<a name="line.351"></a>
<FONT color="green">352</FONT>    <a name="line.352"></a>
<FONT color="green">353</FONT>        /**<a name="line.353"></a>
<FONT color="green">354</FONT>         * Constant for the key of the result declaration. This key can point to a<a name="line.354"></a>
<FONT color="green">355</FONT>         * bean declaration, which defines properties of the resulting combined<a name="line.355"></a>
<FONT color="green">356</FONT>         * configuration.<a name="line.356"></a>
<FONT color="green">357</FONT>         */<a name="line.357"></a>
<FONT color="green">358</FONT>        static final String KEY_RESULT = SEC_HEADER + ".result";<a name="line.358"></a>
<FONT color="green">359</FONT>    <a name="line.359"></a>
<FONT color="green">360</FONT>        /** Constant for the key of the combiner in the result declaration.*/<a name="line.360"></a>
<FONT color="green">361</FONT>        static final String KEY_COMBINER = KEY_RESULT + ".nodeCombiner";<a name="line.361"></a>
<FONT color="green">362</FONT>    <a name="line.362"></a>
<FONT color="green">363</FONT>        /** Constant for the XML file extension. */<a name="line.363"></a>
<FONT color="green">364</FONT>        static final String EXT_XML = ".xml";<a name="line.364"></a>
<FONT color="green">365</FONT>    <a name="line.365"></a>
<FONT color="green">366</FONT>        /** Constant for the provider for properties files. */<a name="line.366"></a>
<FONT color="green">367</FONT>        private static final ConfigurationProvider PROPERTIES_PROVIDER = new FileExtensionConfigurationProvider(<a name="line.367"></a>
<FONT color="green">368</FONT>                XMLPropertiesConfiguration.class, PropertiesConfiguration.class,<a name="line.368"></a>
<FONT color="green">369</FONT>                EXT_XML);<a name="line.369"></a>
<FONT color="green">370</FONT>    <a name="line.370"></a>
<FONT color="green">371</FONT>        /** Constant for the provider for XML files. */<a name="line.371"></a>
<FONT color="green">372</FONT>        private static final ConfigurationProvider XML_PROVIDER = new XMLConfigurationProvider();<a name="line.372"></a>
<FONT color="green">373</FONT>    <a name="line.373"></a>
<FONT color="green">374</FONT>        /** Constant for the provider for JNDI sources. */<a name="line.374"></a>
<FONT color="green">375</FONT>        private static final ConfigurationProvider JNDI_PROVIDER = new ConfigurationProvider(<a name="line.375"></a>
<FONT color="green">376</FONT>                JNDIConfiguration.class);<a name="line.376"></a>
<FONT color="green">377</FONT>    <a name="line.377"></a>
<FONT color="green">378</FONT>        /** Constant for the provider for system properties. */<a name="line.378"></a>
<FONT color="green">379</FONT>        private static final ConfigurationProvider SYSTEM_PROVIDER = new ConfigurationProvider(<a name="line.379"></a>
<FONT color="green">380</FONT>                SystemConfiguration.class);<a name="line.380"></a>
<FONT color="green">381</FONT>    <a name="line.381"></a>
<FONT color="green">382</FONT>        /** Constant for the provider for ini files. */<a name="line.382"></a>
<FONT color="green">383</FONT>        private static final ConfigurationProvider INI_PROVIDER =<a name="line.383"></a>
<FONT color="green">384</FONT>                new FileConfigurationProvider(HierarchicalINIConfiguration.class);<a name="line.384"></a>
<FONT color="green">385</FONT>    <a name="line.385"></a>
<FONT color="green">386</FONT>        /** Constant for the provider for environment properties. */<a name="line.386"></a>
<FONT color="green">387</FONT>        private static final ConfigurationProvider ENV_PROVIDER =<a name="line.387"></a>
<FONT color="green">388</FONT>                new ConfigurationProvider(EnvironmentConfiguration.class);<a name="line.388"></a>
<FONT color="green">389</FONT>    <a name="line.389"></a>
<FONT color="green">390</FONT>        /** Constant for the provider for plist files. */<a name="line.390"></a>
<FONT color="green">391</FONT>        private static final ConfigurationProvider PLIST_PROVIDER = new FileExtensionConfigurationProvider(<a name="line.391"></a>
<FONT color="green">392</FONT>                "org.apache.commons.configuration.plist.XMLPropertyListConfiguration",<a name="line.392"></a>
<FONT color="green">393</FONT>                "org.apache.commons.configuration.plist.PropertyListConfiguration",<a name="line.393"></a>
<FONT color="green">394</FONT>                EXT_XML);<a name="line.394"></a>
<FONT color="green">395</FONT>    <a name="line.395"></a>
<FONT color="green">396</FONT>        /** Constant for the provider for configuration definition files.*/<a name="line.396"></a>
<FONT color="green">397</FONT>        private static final ConfigurationProvider BUILDER_PROVIDER = new ConfigurationBuilderProvider();<a name="line.397"></a>
<FONT color="green">398</FONT>    <a name="line.398"></a>
<FONT color="green">399</FONT>        /** An array with the names of the default tags. */<a name="line.399"></a>
<FONT color="green">400</FONT>        private static final String[] DEFAULT_TAGS = {<a name="line.400"></a>
<FONT color="green">401</FONT>                "properties", "xml", "hierarchicalXml", "jndi", "system", "plist",<a name="line.401"></a>
<FONT color="green">402</FONT>                "configuration", "ini", "env"<a name="line.402"></a>
<FONT color="green">403</FONT>        };<a name="line.403"></a>
<FONT color="green">404</FONT>    <a name="line.404"></a>
<FONT color="green">405</FONT>        /** An array with the providers for the default tags. */<a name="line.405"></a>
<FONT color="green">406</FONT>        private static final ConfigurationProvider[] DEFAULT_PROVIDERS = {<a name="line.406"></a>
<FONT color="green">407</FONT>                PROPERTIES_PROVIDER, XML_PROVIDER, XML_PROVIDER, JNDI_PROVIDER,<a name="line.407"></a>
<FONT color="green">408</FONT>                SYSTEM_PROVIDER, PLIST_PROVIDER, BUILDER_PROVIDER, INI_PROVIDER,<a name="line.408"></a>
<FONT color="green">409</FONT>                ENV_PROVIDER<a name="line.409"></a>
<FONT color="green">410</FONT>        };<a name="line.410"></a>
<FONT color="green">411</FONT>    <a name="line.411"></a>
<FONT color="green">412</FONT>        /**<a name="line.412"></a>
<FONT color="green">413</FONT>         * The serial version UID.<a name="line.413"></a>
<FONT color="green">414</FONT>         */<a name="line.414"></a>
<FONT color="green">415</FONT>        private static final long serialVersionUID = -3113777854714492123L;<a name="line.415"></a>
<FONT color="green">416</FONT>    <a name="line.416"></a>
<FONT color="green">417</FONT>        /**<a name="line.417"></a>
<FONT color="green">418</FONT>         * A specialized {@code StrLookup} object which operates on the combined<a name="line.418"></a>
<FONT color="green">419</FONT>         * configuration constructed by this builder. This object is used as<a name="line.419"></a>
<FONT color="green">420</FONT>         * default lookup for {@code ConfigurationInterpolator} objects assigned to<a name="line.420"></a>
<FONT color="green">421</FONT>         * newly created configuration objects.<a name="line.421"></a>
<FONT color="green">422</FONT>         */<a name="line.422"></a>
<FONT color="green">423</FONT>        private final StrLookup combinedConfigLookup = new StrLookup()<a name="line.423"></a>
<FONT color="green">424</FONT>        {<a name="line.424"></a>
<FONT color="green">425</FONT>            @Override<a name="line.425"></a>
<FONT color="green">426</FONT>            public String lookup(String key)<a name="line.426"></a>
<FONT color="green">427</FONT>            {<a name="line.427"></a>
<FONT color="green">428</FONT>                if (constructedConfiguration != null)<a name="line.428"></a>
<FONT color="green">429</FONT>                {<a name="line.429"></a>
<FONT color="green">430</FONT>                    Object value =<a name="line.430"></a>
<FONT color="green">431</FONT>                            constructedConfiguration.resolveContainerStore(key);<a name="line.431"></a>
<FONT color="green">432</FONT>                    return (value != null) ? value.toString() : null;<a name="line.432"></a>
<FONT color="green">433</FONT>                }<a name="line.433"></a>
<FONT color="green">434</FONT>                return null;<a name="line.434"></a>
<FONT color="green">435</FONT>            }<a name="line.435"></a>
<FONT color="green">436</FONT>        };<a name="line.436"></a>
<FONT color="green">437</FONT>    <a name="line.437"></a>
<FONT color="green">438</FONT>        /** Stores the configuration that is currently constructed.*/<a name="line.438"></a>
<FONT color="green">439</FONT>        private CombinedConfiguration constructedConfiguration;<a name="line.439"></a>
<FONT color="green">440</FONT>    <a name="line.440"></a>
<FONT color="green">441</FONT>        /** Stores a map with the registered configuration providers. */<a name="line.441"></a>
<FONT color="green">442</FONT>        private final Map&lt;String, ConfigurationProvider&gt; providers;<a name="line.442"></a>
<FONT color="green">443</FONT>    <a name="line.443"></a>
<FONT color="green">444</FONT>        /** Stores the base path to the configuration sources to load. */<a name="line.444"></a>
<FONT color="green">445</FONT>        private String configurationBasePath;<a name="line.445"></a>
<FONT color="green">446</FONT>    <a name="line.446"></a>
<FONT color="green">447</FONT>        /**<a name="line.447"></a>
<FONT color="green">448</FONT>         * Creates a new instance of {@code DefaultConfigurationBuilder}. A<a name="line.448"></a>
<FONT color="green">449</FONT>         * configuration definition file is not yet loaded. Use the diverse setter<a name="line.449"></a>
<FONT color="green">450</FONT>         * methods provided by file based configurations to specify the<a name="line.450"></a>
<FONT color="green">451</FONT>         * configuration definition file.<a name="line.451"></a>
<FONT color="green">452</FONT>         */<a name="line.452"></a>
<FONT color="green">453</FONT>        public DefaultConfigurationBuilder()<a name="line.453"></a>
<FONT color="green">454</FONT>        {<a name="line.454"></a>
<FONT color="green">455</FONT>            super();<a name="line.455"></a>
<FONT color="green">456</FONT>            providers = new HashMap&lt;String, ConfigurationProvider&gt;();<a name="line.456"></a>
<FONT color="green">457</FONT>            registerDefaultProviders();<a name="line.457"></a>
<FONT color="green">458</FONT>            registerBeanFactory();<a name="line.458"></a>
<FONT color="green">459</FONT>            setLogger(LogFactory.getLog(getClass()));<a name="line.459"></a>
<FONT color="green">460</FONT>            addErrorLogListener();  // log errors per default<a name="line.460"></a>
<FONT color="green">461</FONT>        }<a name="line.461"></a>
<FONT color="green">462</FONT>    <a name="line.462"></a>
<FONT color="green">463</FONT>        /**<a name="line.463"></a>
<FONT color="green">464</FONT>         * Creates a new instance of {@code DefaultConfigurationBuilder} and<a name="line.464"></a>
<FONT color="green">465</FONT>         * sets the specified configuration definition file.<a name="line.465"></a>
<FONT color="green">466</FONT>         *<a name="line.466"></a>
<FONT color="green">467</FONT>         * @param file the configuration definition file<a name="line.467"></a>
<FONT color="green">468</FONT>         */<a name="line.468"></a>
<FONT color="green">469</FONT>        public DefaultConfigurationBuilder(File file)<a name="line.469"></a>
<FONT color="green">470</FONT>        {<a name="line.470"></a>
<FONT color="green">471</FONT>            this();<a name="line.471"></a>
<FONT color="green">472</FONT>            setFile(file);<a name="line.472"></a>
<FONT color="green">473</FONT>        }<a name="line.473"></a>
<FONT color="green">474</FONT>    <a name="line.474"></a>
<FONT color="green">475</FONT>        /**<a name="line.475"></a>
<FONT color="green">476</FONT>         * Creates a new instance of {@code DefaultConfigurationBuilder} and<a name="line.476"></a>
<FONT color="green">477</FONT>         * sets the specified configuration definition file.<a name="line.477"></a>
<FONT color="green">478</FONT>         *<a name="line.478"></a>
<FONT color="green">479</FONT>         * @param fileName the name of the configuration definition file<a name="line.479"></a>
<FONT color="green">480</FONT>         * @throws ConfigurationException if an error occurs when the file is loaded<a name="line.480"></a>
<FONT color="green">481</FONT>         */<a name="line.481"></a>
<FONT color="green">482</FONT>        public DefaultConfigurationBuilder(String fileName)<a name="line.482"></a>
<FONT color="green">483</FONT>                throws ConfigurationException<a name="line.483"></a>
<FONT color="green">484</FONT>        {<a name="line.484"></a>
<FONT color="green">485</FONT>            this();<a name="line.485"></a>
<FONT color="green">486</FONT>            setFileName(fileName);<a name="line.486"></a>
<FONT color="green">487</FONT>        }<a name="line.487"></a>
<FONT color="green">488</FONT>    <a name="line.488"></a>
<FONT color="green">489</FONT>        /**<a name="line.489"></a>
<FONT color="green">490</FONT>         * Creates a new instance of {@code DefaultConfigurationBuilder} and<a name="line.490"></a>
<FONT color="green">491</FONT>         * sets the specified configuration definition file.<a name="line.491"></a>
<FONT color="green">492</FONT>         *<a name="line.492"></a>
<FONT color="green">493</FONT>         * @param url the URL to the configuration definition file<a name="line.493"></a>
<FONT color="green">494</FONT>         * @throws ConfigurationException if an error occurs when the file is loaded<a name="line.494"></a>
<FONT color="green">495</FONT>         */<a name="line.495"></a>
<FONT color="green">496</FONT>        public DefaultConfigurationBuilder(URL url) throws ConfigurationException<a name="line.496"></a>
<FONT color="green">497</FONT>        {<a name="line.497"></a>
<FONT color="green">498</FONT>            this();<a name="line.498"></a>
<FONT color="green">499</FONT>            setURL(url);<a name="line.499"></a>
<FONT color="green">500</FONT>        }<a name="line.500"></a>
<FONT color="green">501</FONT>    <a name="line.501"></a>
<FONT color="green">502</FONT>        /**<a name="line.502"></a>
<FONT color="green">503</FONT>         * Returns the base path for the configuration sources to load. This path is<a name="line.503"></a>
<FONT color="green">504</FONT>         * used to resolve relative paths in the configuration definition file.<a name="line.504"></a>
<FONT color="green">505</FONT>         *<a name="line.505"></a>
<FONT color="green">506</FONT>         * @return the base path for configuration sources<a name="line.506"></a>
<FONT color="green">507</FONT>         */<a name="line.507"></a>
<FONT color="green">508</FONT>        public String getConfigurationBasePath()<a name="line.508"></a>
<FONT color="green">509</FONT>        {<a name="line.509"></a>
<FONT color="green">510</FONT>            return (configurationBasePath != null) ? configurationBasePath<a name="line.510"></a>
<FONT color="green">511</FONT>                    : getBasePath();<a name="line.511"></a>
<FONT color="green">512</FONT>        }<a name="line.512"></a>
<FONT color="green">513</FONT>    <a name="line.513"></a>
<FONT color="green">514</FONT>        /**<a name="line.514"></a>
<FONT color="green">515</FONT>         * Sets the base path for the configuration sources to load. Normally a base<a name="line.515"></a>
<FONT color="green">516</FONT>         * path need not to be set because it is determined by the location of the<a name="line.516"></a>
<FONT color="green">517</FONT>         * configuration definition file to load. All relative paths in this file<a name="line.517"></a>
<FONT color="green">518</FONT>         * are resolved relative to this file. Setting a base path makes sense if<a name="line.518"></a>
<FONT color="green">519</FONT>         * such relative paths should be otherwise resolved, e.g. if the<a name="line.519"></a>
<FONT color="green">520</FONT>         * configuration file is loaded from the class path and all sub<a name="line.520"></a>
<FONT color="green">521</FONT>         * configurations it refers to are stored in a special config directory.<a name="line.521"></a>
<FONT color="green">522</FONT>         *<a name="line.522"></a>
<FONT color="green">523</FONT>         * @param configurationBasePath the new base path to set<a name="line.523"></a>
<FONT color="green">524</FONT>         */<a name="line.524"></a>
<FONT color="green">525</FONT>        public void setConfigurationBasePath(String configurationBasePath)<a name="line.525"></a>
<FONT color="green">526</FONT>        {<a name="line.526"></a>
<FONT color="green">527</FONT>            this.configurationBasePath = configurationBasePath;<a name="line.527"></a>
<FONT color="green">528</FONT>        }<a name="line.528"></a>
<FONT color="green">529</FONT>    <a name="line.529"></a>
<FONT color="green">530</FONT>        /**<a name="line.530"></a>
<FONT color="green">531</FONT>         * Adds a configuration provider for the specified tag. Whenever this tag is<a name="line.531"></a>
<FONT color="green">532</FONT>         * encountered in the configuration definition file this provider will be<a name="line.532"></a>
<FONT color="green">533</FONT>         * called to create the configuration object.<a name="line.533"></a>
<FONT color="green">534</FONT>         *<a name="line.534"></a>
<FONT color="green">535</FONT>         * @param tagName the name of the tag in the configuration definition file<a name="line.535"></a>
<FONT color="green">536</FONT>         * @param provider the provider for this tag<a name="line.536"></a>
<FONT color="green">537</FONT>         */<a name="line.537"></a>
<FONT color="green">538</FONT>        public void addConfigurationProvider(String tagName,<a name="line.538"></a>
<FONT color="green">539</FONT>                ConfigurationProvider provider)<a name="line.539"></a>
<FONT color="green">540</FONT>        {<a name="line.540"></a>
<FONT color="green">541</FONT>            if (tagName == null)<a name="line.541"></a>
<FONT color="green">542</FONT>            {<a name="line.542"></a>
<FONT color="green">543</FONT>                throw new IllegalArgumentException("Tag name must not be null!");<a name="line.543"></a>
<FONT color="green">544</FONT>            }<a name="line.544"></a>
<FONT color="green">545</FONT>            if (provider == null)<a name="line.545"></a>
<FONT color="green">546</FONT>            {<a name="line.546"></a>
<FONT color="green">547</FONT>                throw new IllegalArgumentException("Provider must not be null!");<a name="line.547"></a>
<FONT color="green">548</FONT>            }<a name="line.548"></a>
<FONT color="green">549</FONT>    <a name="line.549"></a>
<FONT color="green">550</FONT>            providers.put(tagName, provider);<a name="line.550"></a>
<FONT color="green">551</FONT>        }<a name="line.551"></a>
<FONT color="green">552</FONT>    <a name="line.552"></a>
<FONT color="green">553</FONT>        /**<a name="line.553"></a>
<FONT color="green">554</FONT>         * Removes the configuration provider for the specified tag name.<a name="line.554"></a>
<FONT color="green">555</FONT>         *<a name="line.555"></a>
<FONT color="green">556</FONT>         * @param tagName the tag name<a name="line.556"></a>
<FONT color="green">557</FONT>         * @return the removed configuration provider or &lt;b&gt;null&lt;/b&gt; if none was<a name="line.557"></a>
<FONT color="green">558</FONT>         * registered for that tag<a name="line.558"></a>
<FONT color="green">559</FONT>         */<a name="line.559"></a>
<FONT color="green">560</FONT>        public ConfigurationProvider removeConfigurationProvider(String tagName)<a name="line.560"></a>
<FONT color="green">561</FONT>        {<a name="line.561"></a>
<FONT color="green">562</FONT>            return providers.remove(tagName);<a name="line.562"></a>
<FONT color="green">563</FONT>        }<a name="line.563"></a>
<FONT color="green">564</FONT>    <a name="line.564"></a>
<FONT color="green">565</FONT>        /**<a name="line.565"></a>
<FONT color="green">566</FONT>         * Returns the configuration provider for the given tag.<a name="line.566"></a>
<FONT color="green">567</FONT>         *<a name="line.567"></a>
<FONT color="green">568</FONT>         * @param tagName the name of the tag<a name="line.568"></a>
<FONT color="green">569</FONT>         * @return the provider that was registered for this tag or &lt;b&gt;null&lt;/b&gt; if<a name="line.569"></a>
<FONT color="green">570</FONT>         * there is none<a name="line.570"></a>
<FONT color="green">571</FONT>         */<a name="line.571"></a>
<FONT color="green">572</FONT>        public ConfigurationProvider providerForTag(String tagName)<a name="line.572"></a>
<FONT color="green">573</FONT>        {<a name="line.573"></a>
<FONT color="green">574</FONT>            return providers.get(tagName);<a name="line.574"></a>
<FONT color="green">575</FONT>        }<a name="line.575"></a>
<FONT color="green">576</FONT>    <a name="line.576"></a>
<FONT color="green">577</FONT>        /**<a name="line.577"></a>
<FONT color="green">578</FONT>         * Returns the configuration provided by this builder. Loads and parses the<a name="line.578"></a>
<FONT color="green">579</FONT>         * configuration definition file and creates instances for the declared<a name="line.579"></a>
<FONT color="green">580</FONT>         * configurations.<a name="line.580"></a>
<FONT color="green">581</FONT>         *<a name="line.581"></a>
<FONT color="green">582</FONT>         * @return the configuration<a name="line.582"></a>
<FONT color="green">583</FONT>         * @throws ConfigurationException if an error occurs<a name="line.583"></a>
<FONT color="green">584</FONT>         */<a name="line.584"></a>
<FONT color="green">585</FONT>        public Configuration getConfiguration() throws ConfigurationException<a name="line.585"></a>
<FONT color="green">586</FONT>        {<a name="line.586"></a>
<FONT color="green">587</FONT>            return getConfiguration(true);<a name="line.587"></a>
<FONT color="green">588</FONT>        }<a name="line.588"></a>
<FONT color="green">589</FONT>    <a name="line.589"></a>
<FONT color="green">590</FONT>        /**<a name="line.590"></a>
<FONT color="green">591</FONT>         * Returns the configuration provided by this builder. If the boolean<a name="line.591"></a>
<FONT color="green">592</FONT>         * parameter is &lt;b&gt;true&lt;/b&gt;, the configuration definition file will be<a name="line.592"></a>
<FONT color="green">593</FONT>         * loaded. It will then be parsed, and instances for the declared<a name="line.593"></a>
<FONT color="green">594</FONT>         * configurations will be created.<a name="line.594"></a>
<FONT color="green">595</FONT>         *<a name="line.595"></a>
<FONT color="green">596</FONT>         * @param load a flag whether the configuration definition file should be<a name="line.596"></a>
<FONT color="green">597</FONT>         * loaded; a value of &lt;b&gt;false&lt;/b&gt; would make sense if the file has already<a name="line.597"></a>
<FONT color="green">598</FONT>         * been created or its content was manipulated using some of the property<a name="line.598"></a>
<FONT color="green">599</FONT>         * accessor methods<a name="line.599"></a>
<FONT color="green">600</FONT>         * @return the configuration<a name="line.600"></a>
<FONT color="green">601</FONT>         * @throws ConfigurationException if an error occurs<a name="line.601"></a>
<FONT color="green">602</FONT>         */<a name="line.602"></a>
<FONT color="green">603</FONT>        public CombinedConfiguration getConfiguration(boolean load)<a name="line.603"></a>
<FONT color="green">604</FONT>                throws ConfigurationException<a name="line.604"></a>
<FONT color="green">605</FONT>        {<a name="line.605"></a>
<FONT color="green">606</FONT>            if (load)<a name="line.606"></a>
<FONT color="green">607</FONT>            {<a name="line.607"></a>
<FONT color="green">608</FONT>                load();<a name="line.608"></a>
<FONT color="green">609</FONT>            }<a name="line.609"></a>
<FONT color="green">610</FONT>    <a name="line.610"></a>
<FONT color="green">611</FONT>            initFileSystem();<a name="line.611"></a>
<FONT color="green">612</FONT>            initSystemProperties();<a name="line.612"></a>
<FONT color="green">613</FONT>            configureEntityResolver();<a name="line.613"></a>
<FONT color="green">614</FONT>            registerConfiguredProviders();<a name="line.614"></a>
<FONT color="green">615</FONT>            registerConfiguredLookups();<a name="line.615"></a>
<FONT color="green">616</FONT>    <a name="line.616"></a>
<FONT color="green">617</FONT>            CombinedConfiguration result = createResultConfiguration();<a name="line.617"></a>
<FONT color="green">618</FONT>            constructedConfiguration = result;<a name="line.618"></a>
<FONT color="green">619</FONT>    <a name="line.619"></a>
<FONT color="green">620</FONT>            List&lt;SubnodeConfiguration&gt; overrides = fetchTopLevelOverrideConfigs();<a name="line.620"></a>
<FONT color="green">621</FONT>            overrides.addAll(fetchChildConfigs(KEY_OVERRIDE));<a name="line.621"></a>
<FONT color="green">622</FONT>            initCombinedConfiguration(result, overrides, KEY_OVERRIDE_LIST);<a name="line.622"></a>
<FONT color="green">623</FONT>    <a name="line.623"></a>
<FONT color="green">624</FONT>            List&lt;SubnodeConfiguration&gt; additionals = fetchChildConfigs(KEY_UNION);<a name="line.624"></a>
<FONT color="green">625</FONT>            if (!additionals.isEmpty())<a name="line.625"></a>
<FONT color="green">626</FONT>            {<a name="line.626"></a>
<FONT color="green">627</FONT>                CombinedConfiguration addConfig = createAdditionalsConfiguration(result);<a name="line.627"></a>
<FONT color="green">628</FONT>                result.addConfiguration(addConfig, ADDITIONAL_NAME);<a name="line.628"></a>
<FONT color="green">629</FONT>                initCombinedConfiguration(addConfig, additionals,<a name="line.629"></a>
<FONT color="green">630</FONT>                        KEY_ADDITIONAL_LIST);<a name="line.630"></a>
<FONT color="green">631</FONT>            }<a name="line.631"></a>
<FONT color="green">632</FONT>    <a name="line.632"></a>
<FONT color="green">633</FONT>            return result;<a name="line.633"></a>
<FONT color="green">634</FONT>        }<a name="line.634"></a>
<FONT color="green">635</FONT>    <a name="line.635"></a>
<FONT color="green">636</FONT>        /**<a name="line.636"></a>
<FONT color="green">637</FONT>         * Creates the resulting combined configuration. This method is called by<a name="line.637"></a>
<FONT color="green">638</FONT>         * {@code getConfiguration()}. It checks whether the<a name="line.638"></a>
<FONT color="green">639</FONT>         * {@code header} section of the configuration definition file<a name="line.639"></a>
<FONT color="green">640</FONT>         * contains a {@code result} element. If this is the case, it will be<a name="line.640"></a>
<FONT color="green">641</FONT>         * used to initialize the properties of the newly created configuration<a name="line.641"></a>
<FONT color="green">642</FONT>         * object.<a name="line.642"></a>
<FONT color="green">643</FONT>         *<a name="line.643"></a>
<FONT color="green">644</FONT>         * @return the resulting configuration object<a name="line.644"></a>
<FONT color="green">645</FONT>         * @throws ConfigurationException if an error occurs<a name="line.645"></a>
<FONT color="green">646</FONT>         */<a name="line.646"></a>
<FONT color="green">647</FONT>        protected CombinedConfiguration createResultConfiguration()<a name="line.647"></a>
<FONT color="green">648</FONT>                throws ConfigurationException<a name="line.648"></a>
<FONT color="green">649</FONT>        {<a name="line.649"></a>
<FONT color="green">650</FONT>            XMLBeanDeclaration decl = new XMLBeanDeclaration(this, KEY_RESULT, true);<a name="line.650"></a>
<FONT color="green">651</FONT>            CombinedConfiguration result = (CombinedConfiguration) BeanHelper<a name="line.651"></a>
<FONT color="green">652</FONT>                    .createBean(decl, CombinedConfiguration.class);<a name="line.652"></a>
<FONT color="green">653</FONT>    <a name="line.653"></a>
<FONT color="green">654</FONT>            if (getMaxIndex(KEY_COMBINER) &lt; 0)<a name="line.654"></a>
<FONT color="green">655</FONT>            {<a name="line.655"></a>
<FONT color="green">656</FONT>                // No combiner defined =&gt; set default<a name="line.656"></a>
<FONT color="green">657</FONT>                result.setNodeCombiner(new OverrideCombiner());<a name="line.657"></a>
<FONT color="green">658</FONT>            }<a name="line.658"></a>
<FONT color="green">659</FONT>    <a name="line.659"></a>
<FONT color="green">660</FONT>            return result;<a name="line.660"></a>
<FONT color="green">661</FONT>        }<a name="line.661"></a>
<FONT color="green">662</FONT>    <a name="line.662"></a>
<FONT color="green">663</FONT>        /**<a name="line.663"></a>
<FONT color="green">664</FONT>         * Creates the {@code CombinedConfiguration} for the configuration<a name="line.664"></a>
<FONT color="green">665</FONT>         * sources in the &lt;code&gt;&amp;lt;additional&amp;gt;&lt;/code&gt; section. This method is<a name="line.665"></a>
<FONT color="green">666</FONT>         * called when the builder constructs the final configuration. It creates a<a name="line.666"></a>
<FONT color="green">667</FONT>         * new {@code CombinedConfiguration} and initializes some properties<a name="line.667"></a>
<FONT color="green">668</FONT>         * from the result configuration.<a name="line.668"></a>
<FONT color="green">669</FONT>         *<a name="line.669"></a>
<FONT color="green">670</FONT>         * @param resultConfig the result configuration (this is the configuration<a name="line.670"></a>
<FONT color="green">671</FONT>         *        that will be returned by the builder)<a name="line.671"></a>
<FONT color="green">672</FONT>         * @return the {@code CombinedConfiguration} for the additional<a name="line.672"></a>
<FONT color="green">673</FONT>         *         configuration sources<a name="line.673"></a>
<FONT color="green">674</FONT>         * @since 1.7<a name="line.674"></a>
<FONT color="green">675</FONT>         */<a name="line.675"></a>
<FONT color="green">676</FONT>        protected CombinedConfiguration createAdditionalsConfiguration(<a name="line.676"></a>
<FONT color="green">677</FONT>                CombinedConfiguration resultConfig)<a name="line.677"></a>
<FONT color="green">678</FONT>        {<a name="line.678"></a>
<FONT color="green">679</FONT>            CombinedConfiguration addConfig =<a name="line.679"></a>
<FONT color="green">680</FONT>                    new CombinedConfiguration(new UnionCombiner());<a name="line.680"></a>
<FONT color="green">681</FONT>            addConfig.setDelimiterParsingDisabled(resultConfig<a name="line.681"></a>
<FONT color="green">682</FONT>                    .isDelimiterParsingDisabled());<a name="line.682"></a>
<FONT color="green">683</FONT>            addConfig.setForceReloadCheck(resultConfig.isForceReloadCheck());<a name="line.683"></a>
<FONT color="green">684</FONT>            addConfig.setIgnoreReloadExceptions(resultConfig<a name="line.684"></a>
<FONT color="green">685</FONT>                    .isIgnoreReloadExceptions());<a name="line.685"></a>
<FONT color="green">686</FONT>            return addConfig;<a name="line.686"></a>
<FONT color="green">687</FONT>        }<a name="line.687"></a>
<FONT color="green">688</FONT>    <a name="line.688"></a>
<FONT color="green">689</FONT>        /**<a name="line.689"></a>
<FONT color="green">690</FONT>         * Initializes a combined configuration for the configurations of a specific<a name="line.690"></a>
<FONT color="green">691</FONT>         * section. This method is called for the override and for the additional<a name="line.691"></a>
<FONT color="green">692</FONT>         * section (if it exists).<a name="line.692"></a>
<FONT color="green">693</FONT>         *<a name="line.693"></a>
<FONT color="green">694</FONT>         * @param config the configuration to be initialized<a name="line.694"></a>
<FONT color="green">695</FONT>         * @param containedConfigs the list with the declarations of the contained<a name="line.695"></a>
<FONT color="green">696</FONT>         * configurations<a name="line.696"></a>
<FONT color="green">697</FONT>         * @param keyListNodes a list with the declaration of list nodes<a name="line.697"></a>
<FONT color="green">698</FONT>         * @throws ConfigurationException if an error occurs<a name="line.698"></a>
<FONT color="green">699</FONT>         */<a name="line.699"></a>
<FONT color="green">700</FONT>        protected void initCombinedConfiguration(CombinedConfiguration config,<a name="line.700"></a>
<FONT color="green">701</FONT>                List&lt;? extends HierarchicalConfiguration&gt; containedConfigs,<a name="line.701"></a>
<FONT color="green">702</FONT>                String keyListNodes) throws ConfigurationException<a name="line.702"></a>
<FONT color="green">703</FONT>        {<a name="line.703"></a>
<FONT color="green">704</FONT>            List&lt;Object&gt; listNodes = getList(keyListNodes);<a name="line.704"></a>
<FONT color="green">705</FONT>            for (Object listNode : listNodes)<a name="line.705"></a>
<FONT color="green">706</FONT>            {<a name="line.706"></a>
<FONT color="green">707</FONT>                config.getNodeCombiner().addListNode((String) listNode);<a name="line.707"></a>
<FONT color="green">708</FONT>            }<a name="line.708"></a>
<FONT color="green">709</FONT>    <a name="line.709"></a>
<FONT color="green">710</FONT>            for (HierarchicalConfiguration conf : containedConfigs)<a name="line.710"></a>
<FONT color="green">711</FONT>            {<a name="line.711"></a>
<FONT color="green">712</FONT>                ConfigurationDeclaration decl = new ConfigurationDeclaration(this,<a name="line.712"></a>
<FONT color="green">713</FONT>                        conf);<a name="line.713"></a>
<FONT color="green">714</FONT>                if (getLogger().isDebugEnabled())<a name="line.714"></a>
<FONT color="green">715</FONT>                {<a name="line.715"></a>
<FONT color="green">716</FONT>                    getLogger().debug("Creating configuration " + decl.getBeanClassName() + " with name "<a name="line.716"></a>
<FONT color="green">717</FONT>                        + decl.getConfiguration().getString(ATTR_NAME));<a name="line.717"></a>
<FONT color="green">718</FONT>                }<a name="line.718"></a>
<FONT color="green">719</FONT>                AbstractConfiguration newConf = createConfigurationAt(decl);<a name="line.719"></a>
<FONT color="green">720</FONT>                if (newConf != null)<a name="line.720"></a>
<FONT color="green">721</FONT>                {<a name="line.721"></a>
<FONT color="green">722</FONT>                    config.addConfiguration(newConf, decl.getConfiguration()<a name="line.722"></a>
<FONT color="green">723</FONT>                            .getString(ATTR_NAME), decl.getAt());<a name="line.723"></a>
<FONT color="green">724</FONT>                }<a name="line.724"></a>
<FONT color="green">725</FONT>            }<a name="line.725"></a>
<FONT color="green">726</FONT>        }<a name="line.726"></a>
<FONT color="green">727</FONT>    <a name="line.727"></a>
<FONT color="green">728</FONT>        /**<a name="line.728"></a>
<FONT color="green">729</FONT>         * Registers the default configuration providers supported by this class.<a name="line.729"></a>
<FONT color="green">730</FONT>         * This method will be called during initialization. It registers<a name="line.730"></a>
<FONT color="green">731</FONT>         * configuration providers for the tags that are supported by default.<a name="line.731"></a>
<FONT color="green">732</FONT>         */<a name="line.732"></a>
<FONT color="green">733</FONT>        protected void registerDefaultProviders()<a name="line.733"></a>
<FONT color="green">734</FONT>        {<a name="line.734"></a>
<FONT color="green">735</FONT>            for (int i = 0; i &lt; DEFAULT_TAGS.length; i++)<a name="line.735"></a>
<FONT color="green">736</FONT>            {<a name="line.736"></a>
<FONT color="green">737</FONT>                addConfigurationProvider(DEFAULT_TAGS[i], DEFAULT_PROVIDERS[i]);<a name="line.737"></a>
<FONT color="green">738</FONT>            }<a name="line.738"></a>
<FONT color="green">739</FONT>        }<a name="line.739"></a>
<FONT color="green">740</FONT>    <a name="line.740"></a>
<FONT color="green">741</FONT>        /**<a name="line.741"></a>
<FONT color="green">742</FONT>         * Registers providers defined in the configuration.<a name="line.742"></a>
<FONT color="green">743</FONT>         *<a name="line.743"></a>
<FONT color="green">744</FONT>         * @throws ConfigurationException if an error occurs<a name="line.744"></a>
<FONT color="green">745</FONT>         */<a name="line.745"></a>
<FONT color="green">746</FONT>        protected void registerConfiguredProviders() throws ConfigurationException<a name="line.746"></a>
<FONT color="green">747</FONT>        {<a name="line.747"></a>
<FONT color="green">748</FONT>            List&lt;HierarchicalConfiguration&gt; nodes = configurationsAt(KEY_CONFIGURATION_PROVIDERS);<a name="line.748"></a>
<FONT color="green">749</FONT>            for (HierarchicalConfiguration config : nodes)<a name="line.749"></a>
<FONT color="green">750</FONT>            {<a name="line.750"></a>
<FONT color="green">751</FONT>                XMLBeanDeclaration decl = new XMLBeanDeclaration(config);<a name="line.751"></a>
<FONT color="green">752</FONT>                String key = config.getString(KEY_PROVIDER_KEY);<a name="line.752"></a>
<FONT color="green">753</FONT>                addConfigurationProvider(key, (ConfigurationProvider) BeanHelper<a name="line.753"></a>
<FONT color="green">754</FONT>                        .createBean(decl));<a name="line.754"></a>
<FONT color="green">755</FONT>            }<a name="line.755"></a>
<FONT color="green">756</FONT>        }<a name="line.756"></a>
<FONT color="green">757</FONT>    <a name="line.757"></a>
<FONT color="green">758</FONT>        /**<a name="line.758"></a>
<FONT color="green">759</FONT>         * Registers StrLookups defined in the configuration.<a name="line.759"></a>
<FONT color="green">760</FONT>         *<a name="line.760"></a>
<FONT color="green">761</FONT>         * @throws ConfigurationException if an error occurs<a name="line.761"></a>
<FONT color="green">762</FONT>         */<a name="line.762"></a>
<FONT color="green">763</FONT>        protected void registerConfiguredLookups() throws ConfigurationException<a name="line.763"></a>
<FONT color="green">764</FONT>        {<a name="line.764"></a>
<FONT color="green">765</FONT>            List&lt;HierarchicalConfiguration&gt; nodes = configurationsAt(KEY_CONFIGURATION_LOOKUPS);<a name="line.765"></a>
<FONT color="green">766</FONT>            for (HierarchicalConfiguration config : nodes)<a name="line.766"></a>
<FONT color="green">767</FONT>            {<a name="line.767"></a>
<FONT color="green">768</FONT>                XMLBeanDeclaration decl = new XMLBeanDeclaration(config);<a name="line.768"></a>
<FONT color="green">769</FONT>                String key = config.getString(KEY_LOOKUP_KEY);<a name="line.769"></a>
<FONT color="green">770</FONT>                StrLookup lookup = (StrLookup) BeanHelper.createBean(decl);<a name="line.770"></a>
<FONT color="green">771</FONT>                BeanHelper.setProperty(lookup, "configuration", this);<a name="line.771"></a>
<FONT color="green">772</FONT>                ConfigurationInterpolator.registerGlobalLookup(key, lookup);<a name="line.772"></a>
<FONT color="green">773</FONT>                this.getInterpolator().registerLookup(key, lookup);<a name="line.773"></a>
<FONT color="green">774</FONT>            }<a name="line.774"></a>
<FONT color="green">775</FONT>        }<a name="line.775"></a>
<FONT color="green">776</FONT>    <a name="line.776"></a>
<FONT color="green">777</FONT>        protected void initFileSystem() throws ConfigurationException<a name="line.777"></a>
<FONT color="green">778</FONT>        {<a name="line.778"></a>
<FONT color="green">779</FONT>            if (getMaxIndex(FILE_SYSTEM) == 0)<a name="line.779"></a>
<FONT color="green">780</FONT>            {<a name="line.780"></a>
<FONT color="green">781</FONT>                HierarchicalConfiguration config = configurationAt(FILE_SYSTEM);<a name="line.781"></a>
<FONT color="green">782</FONT>                XMLBeanDeclaration decl = new XMLBeanDeclaration(config);<a name="line.782"></a>
<FONT color="green">783</FONT>                setFileSystem((FileSystem) BeanHelper.createBean(decl));<a name="line.783"></a>
<FONT color="green">784</FONT>            }<a name="line.784"></a>
<FONT color="green">785</FONT>        }<a name="line.785"></a>
<FONT color="green">786</FONT>    <a name="line.786"></a>
<FONT color="green">787</FONT>        /**<a name="line.787"></a>
<FONT color="green">788</FONT>         * If a property file is configured add the properties to the System properties.<a name="line.788"></a>
<FONT color="green">789</FONT>         * @throws ConfigurationException if an error occurs.<a name="line.789"></a>
<FONT color="green">790</FONT>         */<a name="line.790"></a>
<FONT color="green">791</FONT>        protected void initSystemProperties() throws ConfigurationException<a name="line.791"></a>
<FONT color="green">792</FONT>        {<a name="line.792"></a>
<FONT color="green">793</FONT>            String fileName = getString(KEY_SYSTEM_PROPS);<a name="line.793"></a>
<FONT color="green">794</FONT>            if (fileName != null)<a name="line.794"></a>
<FONT color="green">795</FONT>            {<a name="line.795"></a>
<FONT color="green">796</FONT>                try<a name="line.796"></a>
<FONT color="green">797</FONT>                {<a name="line.797"></a>
<FONT color="green">798</FONT>                   SystemConfiguration.setSystemProperties(getConfigurationBasePath(), fileName);<a name="line.798"></a>
<FONT color="green">799</FONT>                }<a name="line.799"></a>
<FONT color="green">800</FONT>                catch (Exception ex)<a name="line.800"></a>
<FONT color="green">801</FONT>                {<a name="line.801"></a>
<FONT color="green">802</FONT>                    throw new ConfigurationException("Error setting system properties from " + fileName, ex);<a name="line.802"></a>
<FONT color="green">803</FONT>                }<a name="line.803"></a>
<FONT color="green">804</FONT>    <a name="line.804"></a>
<FONT color="green">805</FONT>            }<a name="line.805"></a>
<FONT color="green">806</FONT>        }<a name="line.806"></a>
<FONT color="green">807</FONT>    <a name="line.807"></a>
<FONT color="green">808</FONT>        protected void configureEntityResolver() throws ConfigurationException<a name="line.808"></a>
<FONT color="green">809</FONT>        {<a name="line.809"></a>
<FONT color="green">810</FONT>            if (getMaxIndex(KEY_ENTITY_RESOLVER) == 0)<a name="line.810"></a>
<FONT color="green">811</FONT>            {<a name="line.811"></a>
<FONT color="green">812</FONT>                XMLBeanDeclaration decl = new XMLBeanDeclaration(this, KEY_ENTITY_RESOLVER, true);<a name="line.812"></a>
<FONT color="green">813</FONT>                EntityResolver resolver = (EntityResolver) BeanHelper.createBean(decl, CatalogResolver.class);<a name="line.813"></a>
<FONT color="green">814</FONT>                BeanHelper.setProperty(resolver, "fileSystem", getFileSystem());<a name="line.814"></a>
<FONT color="green">815</FONT>                BeanHelper.setProperty(resolver, "baseDir", getBasePath());<a name="line.815"></a>
<FONT color="green">816</FONT>                BeanHelper.setProperty(resolver, "substitutor", getSubstitutor());<a name="line.816"></a>
<FONT color="green">817</FONT>                setEntityResolver(resolver);<a name="line.817"></a>
<FONT color="green">818</FONT>            }<a name="line.818"></a>
<FONT color="green">819</FONT>        }<a name="line.819"></a>
<FONT color="green">820</FONT>    <a name="line.820"></a>
<FONT color="green">821</FONT>        /**<a name="line.821"></a>
<FONT color="green">822</FONT>         * Performs interpolation. This method will not only take this configuration<a name="line.822"></a>
<FONT color="green">823</FONT>         * instance into account (which is the one that loaded the configuration<a name="line.823"></a>
<FONT color="green">824</FONT>         * definition file), but also the so far constructed combined configuration.<a name="line.824"></a>
<FONT color="green">825</FONT>         * So variables can be used that point to properties that are defined in<a name="line.825"></a>
<FONT color="green">826</FONT>         * configuration sources loaded by this builder.<a name="line.826"></a>
<FONT color="green">827</FONT>         *<a name="line.827"></a>
<FONT color="green">828</FONT>         * @param value the value to be interpolated<a name="line.828"></a>
<FONT color="green">829</FONT>         * @return the interpolated value<a name="line.829"></a>
<FONT color="green">830</FONT>         */<a name="line.830"></a>
<FONT color="green">831</FONT>        @Override<a name="line.831"></a>
<FONT color="green">832</FONT>        protected Object interpolate(Object value)<a name="line.832"></a>
<FONT color="green">833</FONT>        {<a name="line.833"></a>
<FONT color="green">834</FONT>            Object result = super.interpolate(value);<a name="line.834"></a>
<FONT color="green">835</FONT>            if (constructedConfiguration != null)<a name="line.835"></a>
<FONT color="green">836</FONT>            {<a name="line.836"></a>
<FONT color="green">837</FONT>                result = constructedConfiguration.interpolate(result);<a name="line.837"></a>
<FONT color="green">838</FONT>            }<a name="line.838"></a>
<FONT color="green">839</FONT>            return result;<a name="line.839"></a>
<FONT color="green">840</FONT>        }<a name="line.840"></a>
<FONT color="green">841</FONT>    <a name="line.841"></a>
<FONT color="green">842</FONT>        /**<a name="line.842"></a>
<FONT color="green">843</FONT>         * Creates a configuration object from the specified configuration<a name="line.843"></a>
<FONT color="green">844</FONT>         * declaration.<a name="line.844"></a>
<FONT color="green">845</FONT>         *<a name="line.845"></a>
<FONT color="green">846</FONT>         * @param decl the configuration declaration<a name="line.846"></a>
<FONT color="green">847</FONT>         * @return the new configuration object<a name="line.847"></a>
<FONT color="green">848</FONT>         * @throws ConfigurationException if an error occurs<a name="line.848"></a>
<FONT color="green">849</FONT>         */<a name="line.849"></a>
<FONT color="green">850</FONT>        private AbstractConfiguration createConfigurationAt(<a name="line.850"></a>
<FONT color="green">851</FONT>                ConfigurationDeclaration decl) throws ConfigurationException<a name="line.851"></a>
<FONT color="green">852</FONT>        {<a name="line.852"></a>
<FONT color="green">853</FONT>            try<a name="line.853"></a>
<FONT color="green">854</FONT>            {<a name="line.854"></a>
<FONT color="green">855</FONT>                return (AbstractConfiguration) BeanHelper.createBean(decl);<a name="line.855"></a>
<FONT color="green">856</FONT>            }<a name="line.856"></a>
<FONT color="green">857</FONT>            catch (Exception ex)<a name="line.857"></a>
<FONT color="green">858</FONT>            {<a name="line.858"></a>
<FONT color="green">859</FONT>                // redirect to configuration exceptions<a name="line.859"></a>
<FONT color="green">860</FONT>                throw new ConfigurationException(ex);<a name="line.860"></a>
<FONT color="green">861</FONT>            }<a name="line.861"></a>
<FONT color="green">862</FONT>        }<a name="line.862"></a>
<FONT color="green">863</FONT>    <a name="line.863"></a>
<FONT color="green">864</FONT>        /**<a name="line.864"></a>
<FONT color="green">865</FONT>         * Returns a list with {@code SubnodeConfiguration} objects for the<a name="line.865"></a>
<FONT color="green">866</FONT>         * child nodes of the specified configuration node.<a name="line.866"></a>
<FONT color="green">867</FONT>         *<a name="line.867"></a>
<FONT color="green">868</FONT>         * @param node the start node<a name="line.868"></a>
<FONT color="green">869</FONT>         * @return a list with subnode configurations for the node's children<a name="line.869"></a>
<FONT color="green">870</FONT>         */<a name="line.870"></a>
<FONT color="green">871</FONT>        private List&lt;SubnodeConfiguration&gt; fetchChildConfigs(ConfigurationNode node)<a name="line.871"></a>
<FONT color="green">872</FONT>        {<a name="line.872"></a>
<FONT color="green">873</FONT>            List&lt;ConfigurationNode&gt; children = node.getChildren();<a name="line.873"></a>
<FONT color="green">874</FONT>            List&lt;SubnodeConfiguration&gt; result = new ArrayList&lt;SubnodeConfiguration&gt;(children.size());<a name="line.874"></a>
<FONT color="green">875</FONT>            for (ConfigurationNode child : children)<a name="line.875"></a>
<FONT color="green">876</FONT>            {<a name="line.876"></a>
<FONT color="green">877</FONT>                result.add(createSubnodeConfiguration(child));<a name="line.877"></a>
<FONT color="green">878</FONT>            }<a name="line.878"></a>
<FONT color="green">879</FONT>            return result;<a name="line.879"></a>
<FONT color="green">880</FONT>        }<a name="line.880"></a>
<FONT color="green">881</FONT>    <a name="line.881"></a>
<FONT color="green">882</FONT>        /**<a name="line.882"></a>
<FONT color="green">883</FONT>         * Returns a list with {@code SubnodeConfiguration} objects for the<a name="line.883"></a>
<FONT color="green">884</FONT>         * child nodes of the node specified by the given key.<a name="line.884"></a>
<FONT color="green">885</FONT>         *<a name="line.885"></a>
<FONT color="green">886</FONT>         * @param key the key (must define exactly one node)<a name="line.886"></a>
<FONT color="green">887</FONT>         * @return a list with subnode configurations for the node's children<a name="line.887"></a>
<FONT color="green">888</FONT>         */<a name="line.888"></a>
<FONT color="green">889</FONT>        private List&lt;SubnodeConfiguration&gt; fetchChildConfigs(String key)<a name="line.889"></a>
<FONT color="green">890</FONT>        {<a name="line.890"></a>
<FONT color="green">891</FONT>            List&lt;ConfigurationNode&gt; nodes = fetchNodeList(key);<a name="line.891"></a>
<FONT color="green">892</FONT>            if (nodes.size() &gt; 0)<a name="line.892"></a>
<FONT color="green">893</FONT>            {<a name="line.893"></a>
<FONT color="green">894</FONT>                return fetchChildConfigs(nodes.get(0));<a name="line.894"></a>
<FONT color="green">895</FONT>            }<a name="line.895"></a>
<FONT color="green">896</FONT>            else<a name="line.896"></a>
<FONT color="green">897</FONT>            {<a name="line.897"></a>
<FONT color="green">898</FONT>                return Collections.emptyList();<a name="line.898"></a>
<FONT color="green">899</FONT>            }<a name="line.899"></a>
<FONT color="green">900</FONT>        }<a name="line.900"></a>
<FONT color="green">901</FONT>    <a name="line.901"></a>
<FONT color="green">902</FONT>        /**<a name="line.902"></a>
<FONT color="green">903</FONT>         * Finds the override configurations that are defined as top level elements<a name="line.903"></a>
<FONT color="green">904</FONT>         * in the configuration definition file. This method will fetch the child<a name="line.904"></a>
<FONT color="green">905</FONT>         * elements of the root node and remove the nodes that represent other<a name="line.905"></a>
<FONT color="green">906</FONT>         * configuration sections. The remaining nodes are treated as definitions<a name="line.906"></a>
<FONT color="green">907</FONT>         * for override configurations.<a name="line.907"></a>
<FONT color="green">908</FONT>         *<a name="line.908"></a>
<FONT color="green">909</FONT>         * @return a list with subnode configurations for the top level override<a name="line.909"></a>
<FONT color="green">910</FONT>         * configurations<a name="line.910"></a>
<FONT color="green">911</FONT>         */<a name="line.911"></a>
<FONT color="green">912</FONT>        private List&lt;SubnodeConfiguration&gt; fetchTopLevelOverrideConfigs()<a name="line.912"></a>
<FONT color="green">913</FONT>        {<a name="line.913"></a>
<FONT color="green">914</FONT>            List&lt;SubnodeConfiguration&gt; configs = fetchChildConfigs(getRootNode());<a name="line.914"></a>
<FONT color="green">915</FONT>            for (Iterator&lt;SubnodeConfiguration&gt; it = configs.iterator(); it.hasNext();)<a name="line.915"></a>
<FONT color="green">916</FONT>            {<a name="line.916"></a>
<FONT color="green">917</FONT>                String nodeName = it.next().getRootNode().getName();<a name="line.917"></a>
<FONT color="green">918</FONT>                for (int i = 0; i &lt; CONFIG_SECTIONS.length; i++)<a name="line.918"></a>
<FONT color="green">919</FONT>                {<a name="line.919"></a>
<FONT color="green">920</FONT>                    if (CONFIG_SECTIONS[i].equals(nodeName))<a name="line.920"></a>
<FONT color="green">921</FONT>                    {<a name="line.921"></a>
<FONT color="green">922</FONT>                        it.remove();<a name="line.922"></a>
<FONT color="green">923</FONT>                        break;<a name="line.923"></a>
<FONT color="green">924</FONT>                    }<a name="line.924"></a>
<FONT color="green">925</FONT>                }<a name="line.925"></a>
<FONT color="green">926</FONT>            }<a name="line.926"></a>
<FONT color="green">927</FONT>            return configs;<a name="line.927"></a>
<FONT color="green">928</FONT>        }<a name="line.928"></a>
<FONT color="green">929</FONT>    <a name="line.929"></a>
<FONT color="green">930</FONT>        /**<a name="line.930"></a>
<FONT color="green">931</FONT>         * Registers the bean factory used by this class if necessary. This method<a name="line.931"></a>
<FONT color="green">932</FONT>         * is called by the constructor to ensure that the required bean factory is<a name="line.932"></a>
<FONT color="green">933</FONT>         * available.<a name="line.933"></a>
<FONT color="green">934</FONT>         */<a name="line.934"></a>
<FONT color="green">935</FONT>        private void registerBeanFactory()<a name="line.935"></a>
<FONT color="green">936</FONT>        {<a name="line.936"></a>
<FONT color="green">937</FONT>            synchronized (DefaultConfigurationBuilder.class)<a name="line.937"></a>
<FONT color="green">938</FONT>            {<a name="line.938"></a>
<FONT color="green">939</FONT>                if (!BeanHelper.registeredFactoryNames().contains(<a name="line.939"></a>
<FONT color="green">940</FONT>                        CONFIG_BEAN_FACTORY_NAME))<a name="line.940"></a>
<FONT color="green">941</FONT>                {<a name="line.941"></a>
<FONT color="green">942</FONT>                    BeanHelper.registerBeanFactory(CONFIG_BEAN_FACTORY_NAME,<a name="line.942"></a>
<FONT color="green">943</FONT>                            new ConfigurationBeanFactory());<a name="line.943"></a>
<FONT color="green">944</FONT>                }<a name="line.944"></a>
<FONT color="green">945</FONT>            }<a name="line.945"></a>
<FONT color="green">946</FONT>        }<a name="line.946"></a>
<FONT color="green">947</FONT>    <a name="line.947"></a>
<FONT color="green">948</FONT>        /**<a name="line.948"></a>
<FONT color="green">949</FONT>         * &lt;p&gt;<a name="line.949"></a>
<FONT color="green">950</FONT>         * A base class for creating and initializing configuration sources.<a name="line.950"></a>
<FONT color="green">951</FONT>         * &lt;/p&gt;<a name="line.951"></a>
<FONT color="green">952</FONT>         * &lt;p&gt;<a name="line.952"></a>
<FONT color="green">953</FONT>         * Concrete sub classes of this base class are responsible for creating<a name="line.953"></a>
<FONT color="green">954</FONT>         * specific {@code Configuration} objects for the tags in the<a name="line.954"></a>
<FONT color="green">955</FONT>         * configuration definition file. The configuration factory will parse the<a name="line.955"></a>
<FONT color="green">956</FONT>         * definition file and try to find a matching<a name="line.956"></a>
<FONT color="green">957</FONT>         * {@code ConfigurationProvider} for each encountered tag. This<a name="line.957"></a>
<FONT color="green">958</FONT>         * provider is then asked to create a corresponding<a name="line.958"></a>
<FONT color="green">959</FONT>         * {@code Configuration} object. It is up to a concrete<a name="line.959"></a>
<FONT color="green">960</FONT>         * implementation how this object is created and initialized.<a name="line.960"></a>
<FONT color="green">961</FONT>         * &lt;/p&gt;<a name="line.961"></a>
<FONT color="green">962</FONT>         * &lt;p&gt;<a name="line.962"></a>
<FONT color="green">963</FONT>         * Note that at the moment only configuration classes derived from<a name="line.963"></a>
<FONT color="green">964</FONT>         * {@link AbstractConfiguration} are supported.<a name="line.964"></a>
<FONT color="green">965</FONT>         * &lt;/p&gt;<a name="line.965"></a>
<FONT color="green">966</FONT>         */<a name="line.966"></a>
<FONT color="green">967</FONT>        public static class ConfigurationProvider extends DefaultBeanFactory<a name="line.967"></a>
<FONT color="green">968</FONT>        {<a name="line.968"></a>
<FONT color="green">969</FONT>            /** Stores the class of the configuration to be created. */<a name="line.969"></a>
<FONT color="green">970</FONT>            private Class&lt;?&gt; configurationClass;<a name="line.970"></a>
<FONT color="green">971</FONT>    <a name="line.971"></a>
<FONT color="green">972</FONT>            /** Stores the name of the configuration class to be created.*/<a name="line.972"></a>
<FONT color="green">973</FONT>            private String configurationClassName;<a name="line.973"></a>
<FONT color="green">974</FONT>    <a name="line.974"></a>
<FONT color="green">975</FONT>            /**<a name="line.975"></a>
<FONT color="green">976</FONT>             * Creates a new uninitialized instance of {@code ConfigurationProvider}.<a name="line.976"></a>
<FONT color="green">977</FONT>             */<a name="line.977"></a>
<FONT color="green">978</FONT>            public ConfigurationProvider()<a name="line.978"></a>
<FONT color="green">979</FONT>            {<a name="line.979"></a>
<FONT color="green">980</FONT>                this((Class&lt;?&gt;) null);<a name="line.980"></a>
<FONT color="green">981</FONT>            }<a name="line.981"></a>
<FONT color="green">982</FONT>    <a name="line.982"></a>
<FONT color="green">983</FONT>            /**<a name="line.983"></a>
<FONT color="green">984</FONT>             * Creates a new instance of {@code ConfigurationProvider} and<a name="line.984"></a>
<FONT color="green">985</FONT>             * sets the class of the configuration created by this provider.<a name="line.985"></a>
<FONT color="green">986</FONT>             *<a name="line.986"></a>
<FONT color="green">987</FONT>             * @param configClass the configuration class<a name="line.987"></a>
<FONT color="green">988</FONT>             */<a name="line.988"></a>
<FONT color="green">989</FONT>            public ConfigurationProvider(Class&lt;?&gt; configClass)<a name="line.989"></a>
<FONT color="green">990</FONT>            {<a name="line.990"></a>
<FONT color="green">991</FONT>                setConfigurationClass(configClass);<a name="line.991"></a>
<FONT color="green">992</FONT>            }<a name="line.992"></a>
<FONT color="green">993</FONT>    <a name="line.993"></a>
<FONT color="green">994</FONT>            /**<a name="line.994"></a>
<FONT color="green">995</FONT>             * Creates a new instance of {@code ConfigurationProvider} and<a name="line.995"></a>
<FONT color="green">996</FONT>             * sets the name of the class of the configuration created by this<a name="line.996"></a>
<FONT color="green">997</FONT>             * provider.<a name="line.997"></a>
<FONT color="green">998</FONT>             *<a name="line.998"></a>
<FONT color="green">999</FONT>             * @param configClassName the name of the configuration class<a name="line.999"></a>
<FONT color="green">1000</FONT>             * @since 1.4<a name="line.1000"></a>
<FONT color="green">1001</FONT>             */<a name="line.1001"></a>
<FONT color="green">1002</FONT>            public ConfigurationProvider(String configClassName)<a name="line.1002"></a>
<FONT color="green">1003</FONT>            {<a name="line.1003"></a>
<FONT color="green">1004</FONT>                setConfigurationClassName(configClassName);<a name="line.1004"></a>
<FONT color="green">1005</FONT>            }<a name="line.1005"></a>
<FONT color="green">1006</FONT>    <a name="line.1006"></a>
<FONT color="green">1007</FONT>            /**<a name="line.1007"></a>
<FONT color="green">1008</FONT>             * Returns the class of the configuration returned by this provider.<a name="line.1008"></a>
<FONT color="green">1009</FONT>             *<a name="line.1009"></a>
<FONT color="green">1010</FONT>             * @return the class of the provided configuration<a name="line.1010"></a>
<FONT color="green">1011</FONT>             */<a name="line.1011"></a>
<FONT color="green">1012</FONT>            public Class&lt;?&gt; getConfigurationClass()<a name="line.1012"></a>
<FONT color="green">1013</FONT>            {<a name="line.1013"></a>
<FONT color="green">1014</FONT>                return configurationClass;<a name="line.1014"></a>
<FONT color="green">1015</FONT>            }<a name="line.1015"></a>
<FONT color="green">1016</FONT>    <a name="line.1016"></a>
<FONT color="green">1017</FONT>            /**<a name="line.1017"></a>
<FONT color="green">1018</FONT>             * Sets the class of the configuration returned by this provider.<a name="line.1018"></a>
<FONT color="green">1019</FONT>             *<a name="line.1019"></a>
<FONT color="green">1020</FONT>             * @param configurationClass the configuration class<a name="line.1020"></a>
<FONT color="green">1021</FONT>             */<a name="line.1021"></a>
<FONT color="green">1022</FONT>            public void setConfigurationClass(Class&lt;?&gt; configurationClass)<a name="line.1022"></a>
<FONT color="green">1023</FONT>            {<a name="line.1023"></a>
<FONT color="green">1024</FONT>                this.configurationClass = configurationClass;<a name="line.1024"></a>
<FONT color="green">1025</FONT>            }<a name="line.1025"></a>
<FONT color="green">1026</FONT>    <a name="line.1026"></a>
<FONT color="green">1027</FONT>            /**<a name="line.1027"></a>
<FONT color="green">1028</FONT>             * Returns the name of the configuration class returned by this<a name="line.1028"></a>
<FONT color="green">1029</FONT>             * provider.<a name="line.1029"></a>
<FONT color="green">1030</FONT>             *<a name="line.1030"></a>
<FONT color="green">1031</FONT>             * @return the configuration class name<a name="line.1031"></a>
<FONT color="green">1032</FONT>             * @since 1.4<a name="line.1032"></a>
<FONT color="green">1033</FONT>             */<a name="line.1033"></a>
<FONT color="green">1034</FONT>            public String getConfigurationClassName()<a name="line.1034"></a>
<FONT color="green">1035</FONT>            {<a name="line.1035"></a>
<FONT color="green">1036</FONT>                return configurationClassName;<a name="line.1036"></a>
<FONT color="green">1037</FONT>            }<a name="line.1037"></a>
<FONT color="green">1038</FONT>    <a name="line.1038"></a>
<FONT color="green">1039</FONT>            /**<a name="line.1039"></a>
<FONT color="green">1040</FONT>             * Sets the name of the configuration class returned by this provider.<a name="line.1040"></a>
<FONT color="green">1041</FONT>             *<a name="line.1041"></a>
<FONT color="green">1042</FONT>             * @param configurationClassName the name of the configuration class<a name="line.1042"></a>
<FONT color="green">1043</FONT>             * @since 1.4<a name="line.1043"></a>
<FONT color="green">1044</FONT>             */<a name="line.1044"></a>
<FONT color="green">1045</FONT>            public void setConfigurationClassName(String configurationClassName)<a name="line.1045"></a>
<FONT color="green">1046</FONT>            {<a name="line.1046"></a>
<FONT color="green">1047</FONT>                this.configurationClassName = configurationClassName;<a name="line.1047"></a>
<FONT color="green">1048</FONT>            }<a name="line.1048"></a>
<FONT color="green">1049</FONT>    <a name="line.1049"></a>
<FONT color="green">1050</FONT>            /**<a name="line.1050"></a>
<FONT color="green">1051</FONT>             * Returns the configuration. This method is called to fetch the<a name="line.1051"></a>
<FONT color="green">1052</FONT>             * configuration from the provider. This implementation will call the<a name="line.1052"></a>
<FONT color="green">1053</FONT>             * inherited {@link<a name="line.1053"></a>
<FONT color="green">1054</FONT>             * org.apache.commons.configuration.beanutils.DefaultBeanFactory#createBean(Class, BeanDeclaration, Object)<a name="line.1054"></a>
<FONT color="green">1055</FONT>             * createBean()} method to create a new instance of the<a name="line.1055"></a>
<FONT color="green">1056</FONT>             * configuration class.<a name="line.1056"></a>
<FONT color="green">1057</FONT>             *<a name="line.1057"></a>
<FONT color="green">1058</FONT>             * @param decl the bean declaration with initialization parameters for<a name="line.1058"></a>
<FONT color="green">1059</FONT>             * the configuration<a name="line.1059"></a>
<FONT color="green">1060</FONT>             * @return the new configuration object<a name="line.1060"></a>
<FONT color="green">1061</FONT>             * @throws Exception if an error occurs<a name="line.1061"></a>
<FONT color="green">1062</FONT>             */<a name="line.1062"></a>
<FONT color="green">1063</FONT>            public AbstractConfiguration getConfiguration(<a name="line.1063"></a>
<FONT color="green">1064</FONT>                    ConfigurationDeclaration decl) throws Exception<a name="line.1064"></a>
<FONT color="green">1065</FONT>            {<a name="line.1065"></a>
<FONT color="green">1066</FONT>                return (AbstractConfiguration) createBean(fetchConfigurationClass(),<a name="line.1066"></a>
<FONT color="green">1067</FONT>                        decl, null);<a name="line.1067"></a>
<FONT color="green">1068</FONT>            }<a name="line.1068"></a>
<FONT color="green">1069</FONT>    <a name="line.1069"></a>
<FONT color="green">1070</FONT>            /**<a name="line.1070"></a>
<FONT color="green">1071</FONT>             * Returns an uninitialized configuration of the represented type. This<a name="line.1071"></a>
<FONT color="green">1072</FONT>             * method will be called for optional configurations when the<a name="line.1072"></a>
<FONT color="green">1073</FONT>             * {@code getConfiguration()} method caused an error and the<a name="line.1073"></a>
<FONT color="green">1074</FONT>             * {@code forceCreate} attribute is set. A concrete sub class can<a name="line.1074"></a>
<FONT color="green">1075</FONT>             * here try to create an uninitialized, empty configuration, which may<a name="line.1075"></a>
<FONT color="green">1076</FONT>             * be possible if the error was created during initialization. This base<a name="line.1076"></a>
<FONT color="green">1077</FONT>             * implementation just returns &lt;b&gt;null&lt;/b&gt;.<a name="line.1077"></a>
<FONT color="green">1078</FONT>             *<a name="line.1078"></a>
<FONT color="green">1079</FONT>             * @param decl the bean declaration with initialization parameters for<a name="line.1079"></a>
<FONT color="green">1080</FONT>             * the configuration<a name="line.1080"></a>
<FONT color="green">1081</FONT>             * @return the new configuration object<a name="line.1081"></a>
<FONT color="green">1082</FONT>             * @throws Exception if an error occurs<a name="line.1082"></a>
<FONT color="green">1083</FONT>             * @since 1.4<a name="line.1083"></a>
<FONT color="green">1084</FONT>             */<a name="line.1084"></a>
<FONT color="green">1085</FONT>            public AbstractConfiguration getEmptyConfiguration(<a name="line.1085"></a>
<FONT color="green">1086</FONT>                    ConfigurationDeclaration decl) throws Exception<a name="line.1086"></a>
<FONT color="green">1087</FONT>            {<a name="line.1087"></a>
<FONT color="green">1088</FONT>                return null;<a name="line.1088"></a>
<FONT color="green">1089</FONT>            }<a name="line.1089"></a>
<FONT color="green">1090</FONT>    <a name="line.1090"></a>
<FONT color="green">1091</FONT>            /**<a name="line.1091"></a>
<FONT color="green">1092</FONT>             * Returns the configuration class supported by this provider. If a<a name="line.1092"></a>
<FONT color="green">1093</FONT>             * class object was set, it is returned. Otherwise the method tries to<a name="line.1093"></a>
<FONT color="green">1094</FONT>             * resolve the class name.<a name="line.1094"></a>
<FONT color="green">1095</FONT>             *<a name="line.1095"></a>
<FONT color="green">1096</FONT>             * @return the class of the configuration to be created<a name="line.1096"></a>
<FONT color="green">1097</FONT>             * @since 1.4<a name="line.1097"></a>
<FONT color="green">1098</FONT>             */<a name="line.1098"></a>
<FONT color="green">1099</FONT>            protected synchronized Class&lt;?&gt; fetchConfigurationClass() throws Exception<a name="line.1099"></a>
<FONT color="green">1100</FONT>            {<a name="line.1100"></a>
<FONT color="green">1101</FONT>                if (getConfigurationClass() == null)<a name="line.1101"></a>
<FONT color="green">1102</FONT>                {<a name="line.1102"></a>
<FONT color="green">1103</FONT>                    setConfigurationClass(loadClass(getConfigurationClassName()));<a name="line.1103"></a>
<FONT color="green">1104</FONT>                }<a name="line.1104"></a>
<FONT color="green">1105</FONT>                return getConfigurationClass();<a name="line.1105"></a>
<FONT color="green">1106</FONT>            }<a name="line.1106"></a>
<FONT color="green">1107</FONT>    <a name="line.1107"></a>
<FONT color="green">1108</FONT>            /**<a name="line.1108"></a>
<FONT color="green">1109</FONT>             * Loads the class with the specified name dynamically. If the class's<a name="line.1109"></a>
<FONT color="green">1110</FONT>             * name is &lt;b&gt;null&lt;/b&gt;, &lt;b&gt;null&lt;/b&gt; will also be returned.<a name="line.1110"></a>
<FONT color="green">1111</FONT>             *<a name="line.1111"></a>
<FONT color="green">1112</FONT>             * @param className the name of the class to be loaded<a name="line.1112"></a>
<FONT color="green">1113</FONT>             * @return the class object<a name="line.1113"></a>
<FONT color="green">1114</FONT>             * @throws ClassNotFoundException if class loading fails<a name="line.1114"></a>
<FONT color="green">1115</FONT>             * @since 1.4<a name="line.1115"></a>
<FONT color="green">1116</FONT>             */<a name="line.1116"></a>
<FONT color="green">1117</FONT>            protected Class&lt;?&gt; loadClass(String className)<a name="line.1117"></a>
<FONT color="green">1118</FONT>                    throws ClassNotFoundException<a name="line.1118"></a>
<FONT color="green">1119</FONT>            {<a name="line.1119"></a>
<FONT color="green">1120</FONT>                return (className != null) ? Class.forName(className, true,<a name="line.1120"></a>
<FONT color="green">1121</FONT>                        getClass().getClassLoader()) : null;<a name="line.1121"></a>
<FONT color="green">1122</FONT>            }<a name="line.1122"></a>
<FONT color="green">1123</FONT>        }<a name="line.1123"></a>
<FONT color="green">1124</FONT>    <a name="line.1124"></a>
<FONT color="green">1125</FONT>        /**<a name="line.1125"></a>
<FONT color="green">1126</FONT>         * &lt;p&gt;<a name="line.1126"></a>
<FONT color="green">1127</FONT>         * A specialized {@code BeanDeclaration} implementation that<a name="line.1127"></a>
<FONT color="green">1128</FONT>         * represents the declaration of a configuration source.<a name="line.1128"></a>
<FONT color="green">1129</FONT>         * &lt;/p&gt;<a name="line.1129"></a>
<FONT color="green">1130</FONT>         * &lt;p&gt;<a name="line.1130"></a>
<FONT color="green">1131</FONT>         * Instances of this class are able to extract all information about a<a name="line.1131"></a>
<FONT color="green">1132</FONT>         * configuration source from the configuration definition file. The<a name="line.1132"></a>
<FONT color="green">1133</FONT>         * declaration of a configuration source is very similar to a bean<a name="line.1133"></a>
<FONT color="green">1134</FONT>         * declaration processed by {@code XMLBeanDeclaration}. There are<a name="line.1134"></a>
<FONT color="green">1135</FONT>         * very few differences, e.g. some reserved attributes like<a name="line.1135"></a>
<FONT color="green">1136</FONT>         * {@code optional} and {@code at} and the fact that a bean<a name="line.1136"></a>
<FONT color="green">1137</FONT>         * factory is never needed.<a name="line.1137"></a>
<FONT color="green">1138</FONT>         * &lt;/p&gt;<a name="line.1138"></a>
<FONT color="green">1139</FONT>         */<a name="line.1139"></a>
<FONT color="green">1140</FONT>        public static class ConfigurationDeclaration extends XMLBeanDeclaration<a name="line.1140"></a>
<FONT color="green">1141</FONT>        {<a name="line.1141"></a>
<FONT color="green">1142</FONT>            /** Stores a reference to the associated configuration builder. */<a name="line.1142"></a>
<FONT color="green">1143</FONT>            private DefaultConfigurationBuilder configurationBuilder;<a name="line.1143"></a>
<FONT color="green">1144</FONT>    <a name="line.1144"></a>
<FONT color="green">1145</FONT>            /**<a name="line.1145"></a>
<FONT color="green">1146</FONT>             * Creates a new instance of {@code ConfigurationDeclaration} and<a name="line.1146"></a>
<FONT color="green">1147</FONT>             * initializes it.<a name="line.1147"></a>
<FONT color="green">1148</FONT>             *<a name="line.1148"></a>
<FONT color="green">1149</FONT>             * @param builder the associated configuration builder<a name="line.1149"></a>
<FONT color="green">1150</FONT>             * @param config the configuration this declaration is based onto<a name="line.1150"></a>
<FONT color="green">1151</FONT>             */<a name="line.1151"></a>
<FONT color="green">1152</FONT>            public ConfigurationDeclaration(DefaultConfigurationBuilder builder,<a name="line.1152"></a>
<FONT color="green">1153</FONT>                    HierarchicalConfiguration config)<a name="line.1153"></a>
<FONT color="green">1154</FONT>            {<a name="line.1154"></a>
<FONT color="green">1155</FONT>                super(config);<a name="line.1155"></a>
<FONT color="green">1156</FONT>                configurationBuilder = builder;<a name="line.1156"></a>
<FONT color="green">1157</FONT>            }<a name="line.1157"></a>
<FONT color="green">1158</FONT>    <a name="line.1158"></a>
<FONT color="green">1159</FONT>            /**<a name="line.1159"></a>
<FONT color="green">1160</FONT>             * Returns the associated configuration builder.<a name="line.1160"></a>
<FONT color="green">1161</FONT>             *<a name="line.1161"></a>
<FONT color="green">1162</FONT>             * @return the configuration builder<a name="line.1162"></a>
<FONT color="green">1163</FONT>             */<a name="line.1163"></a>
<FONT color="green">1164</FONT>            public DefaultConfigurationBuilder getConfigurationBuilder()<a name="line.1164"></a>
<FONT color="green">1165</FONT>            {<a name="line.1165"></a>
<FONT color="green">1166</FONT>                return configurationBuilder;<a name="line.1166"></a>
<FONT color="green">1167</FONT>            }<a name="line.1167"></a>
<FONT color="green">1168</FONT>    <a name="line.1168"></a>
<FONT color="green">1169</FONT>            /**<a name="line.1169"></a>
<FONT color="green">1170</FONT>             * Returns the value of the {@code at} attribute.<a name="line.1170"></a>
<FONT color="green">1171</FONT>             *<a name="line.1171"></a>
<FONT color="green">1172</FONT>             * @return the value of the {@code at} attribute (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.1172"></a>
<FONT color="green">1173</FONT>             */<a name="line.1173"></a>
<FONT color="green">1174</FONT>            public String getAt()<a name="line.1174"></a>
<FONT color="green">1175</FONT>            {<a name="line.1175"></a>
<FONT color="green">1176</FONT>                String result = this.getConfiguration().getString(ATTR_AT_RES);<a name="line.1176"></a>
<FONT color="green">1177</FONT>                return (result == null) ? this.getConfiguration().getString(ATTR_AT)<a name="line.1177"></a>
<FONT color="green">1178</FONT>                        : result;<a name="line.1178"></a>
<FONT color="green">1179</FONT>            }<a name="line.1179"></a>
<FONT color="green">1180</FONT>    <a name="line.1180"></a>
<FONT color="green">1181</FONT>            /**<a name="line.1181"></a>
<FONT color="green">1182</FONT>             * Returns a flag whether this is an optional configuration.<a name="line.1182"></a>
<FONT color="green">1183</FONT>             *<a name="line.1183"></a>
<FONT color="green">1184</FONT>             * @return a flag if this declaration points to an optional<a name="line.1184"></a>
<FONT color="green">1185</FONT>             * configuration<a name="line.1185"></a>
<FONT color="green">1186</FONT>             */<a name="line.1186"></a>
<FONT color="green">1187</FONT>            public boolean isOptional()<a name="line.1187"></a>
<FONT color="green">1188</FONT>            {<a name="line.1188"></a>
<FONT color="green">1189</FONT>                Boolean value = this.getConfiguration().getBoolean(ATTR_OPTIONAL_RES,<a name="line.1189"></a>
<FONT color="green">1190</FONT>                        null);<a name="line.1190"></a>
<FONT color="green">1191</FONT>                if (value == null)<a name="line.1191"></a>
<FONT color="green">1192</FONT>                {<a name="line.1192"></a>
<FONT color="green">1193</FONT>                    value = this.getConfiguration().getBoolean(ATTR_OPTIONAL,<a name="line.1193"></a>
<FONT color="green">1194</FONT>                            Boolean.FALSE);<a name="line.1194"></a>
<FONT color="green">1195</FONT>                }<a name="line.1195"></a>
<FONT color="green">1196</FONT>                return value.booleanValue();<a name="line.1196"></a>
<FONT color="green">1197</FONT>            }<a name="line.1197"></a>
<FONT color="green">1198</FONT>    <a name="line.1198"></a>
<FONT color="green">1199</FONT>            /**<a name="line.1199"></a>
<FONT color="green">1200</FONT>             * Returns a flag whether this configuration should always be created<a name="line.1200"></a>
<FONT color="green">1201</FONT>             * and added to the resulting combined configuration. This flag is<a name="line.1201"></a>
<FONT color="green">1202</FONT>             * evaluated only for optional configurations whose normal creation has<a name="line.1202"></a>
<FONT color="green">1203</FONT>             * caused an error. If for such a configuration the<a name="line.1203"></a>
<FONT color="green">1204</FONT>             * {@code forceCreate} attribute is set and the corresponding<a name="line.1204"></a>
<FONT color="green">1205</FONT>             * configuration provider supports this mode, an empty configuration<a name="line.1205"></a>
<FONT color="green">1206</FONT>             * will be created and added to the resulting combined configuration.<a name="line.1206"></a>
<FONT color="green">1207</FONT>             *<a name="line.1207"></a>
<FONT color="green">1208</FONT>             * @return the value of the {@code forceCreate} attribute<a name="line.1208"></a>
<FONT color="green">1209</FONT>             * @since 1.4<a name="line.1209"></a>
<FONT color="green">1210</FONT>             */<a name="line.1210"></a>
<FONT color="green">1211</FONT>            public boolean isForceCreate()<a name="line.1211"></a>
<FONT color="green">1212</FONT>            {<a name="line.1212"></a>
<FONT color="green">1213</FONT>                return this.getConfiguration().getBoolean(ATTR_FORCECREATE, false);<a name="line.1213"></a>
<FONT color="green">1214</FONT>            }<a name="line.1214"></a>
<FONT color="green">1215</FONT>    <a name="line.1215"></a>
<FONT color="green">1216</FONT>            /**<a name="line.1216"></a>
<FONT color="green">1217</FONT>             * Returns the name of the bean factory. For configuration source<a name="line.1217"></a>
<FONT color="green">1218</FONT>             * declarations always a reserved factory is used. This factory's name<a name="line.1218"></a>
<FONT color="green">1219</FONT>             * is returned by this implementation.<a name="line.1219"></a>
<FONT color="green">1220</FONT>             *<a name="line.1220"></a>
<FONT color="green">1221</FONT>             * @return the name of the bean factory<a name="line.1221"></a>
<FONT color="green">1222</FONT>             */<a name="line.1222"></a>
<FONT color="green">1223</FONT>            @Override<a name="line.1223"></a>
<FONT color="green">1224</FONT>            public String getBeanFactoryName()<a name="line.1224"></a>
<FONT color="green">1225</FONT>            {<a name="line.1225"></a>
<FONT color="green">1226</FONT>                return CONFIG_BEAN_FACTORY_NAME;<a name="line.1226"></a>
<FONT color="green">1227</FONT>            }<a name="line.1227"></a>
<FONT color="green">1228</FONT>    <a name="line.1228"></a>
<FONT color="green">1229</FONT>            /**<a name="line.1229"></a>
<FONT color="green">1230</FONT>             * Returns the bean's class name. This implementation will always return<a name="line.1230"></a>
<FONT color="green">1231</FONT>             * &lt;b&gt;null&lt;/b&gt;.<a name="line.1231"></a>
<FONT color="green">1232</FONT>             *<a name="line.1232"></a>
<FONT color="green">1233</FONT>             * @return the name of the bean's class<a name="line.1233"></a>
<FONT color="green">1234</FONT>             */<a name="line.1234"></a>
<FONT color="green">1235</FONT>            @Override<a name="line.1235"></a>
<FONT color="green">1236</FONT>            public String getBeanClassName()<a name="line.1236"></a>
<FONT color="green">1237</FONT>            {<a name="line.1237"></a>
<FONT color="green">1238</FONT>                return null;<a name="line.1238"></a>
<FONT color="green">1239</FONT>            }<a name="line.1239"></a>
<FONT color="green">1240</FONT>    <a name="line.1240"></a>
<FONT color="green">1241</FONT>            /**<a name="line.1241"></a>
<FONT color="green">1242</FONT>             * Checks whether the given node is reserved. This method will take<a name="line.1242"></a>
<FONT color="green">1243</FONT>             * further reserved attributes into account<a name="line.1243"></a>
<FONT color="green">1244</FONT>             *<a name="line.1244"></a>
<FONT color="green">1245</FONT>             * @param nd the node<a name="line.1245"></a>
<FONT color="green">1246</FONT>             * @return a flag whether this node is reserved<a name="line.1246"></a>
<FONT color="green">1247</FONT>             */<a name="line.1247"></a>
<FONT color="green">1248</FONT>            @Override<a name="line.1248"></a>
<FONT color="green">1249</FONT>            protected boolean isReservedNode(ConfigurationNode nd)<a name="line.1249"></a>
<FONT color="green">1250</FONT>            {<a name="line.1250"></a>
<FONT color="green">1251</FONT>                if (super.isReservedNode(nd))<a name="line.1251"></a>
<FONT color="green">1252</FONT>                {<a name="line.1252"></a>
<FONT color="green">1253</FONT>                    return true;<a name="line.1253"></a>
<FONT color="green">1254</FONT>                }<a name="line.1254"></a>
<FONT color="green">1255</FONT>    <a name="line.1255"></a>
<FONT color="green">1256</FONT>                return nd.isAttribute()<a name="line.1256"></a>
<FONT color="green">1257</FONT>                        &amp;&amp; ((ATTR_ATNAME.equals(nd.getName()) &amp;&amp; nd.getParentNode()<a name="line.1257"></a>
<FONT color="green">1258</FONT>                                .getAttributeCount(RESERVED_PREFIX + ATTR_ATNAME) == 0) || (ATTR_OPTIONALNAME<a name="line.1258"></a>
<FONT color="green">1259</FONT>                                .equals(nd.getName()) &amp;&amp; nd.getParentNode()<a name="line.1259"></a>
<FONT color="green">1260</FONT>                                .getAttributeCount(RESERVED_PREFIX + ATTR_OPTIONALNAME) == 0));<a name="line.1260"></a>
<FONT color="green">1261</FONT>            }<a name="line.1261"></a>
<FONT color="green">1262</FONT>    <a name="line.1262"></a>
<FONT color="green">1263</FONT>            /**<a name="line.1263"></a>
<FONT color="green">1264</FONT>             * Performs interpolation. This implementation will delegate<a name="line.1264"></a>
<FONT color="green">1265</FONT>             * interpolation to the configuration builder, which takes care that the<a name="line.1265"></a>
<FONT color="green">1266</FONT>             * currently constructed configuration is taken into account, too.<a name="line.1266"></a>
<FONT color="green">1267</FONT>             *<a name="line.1267"></a>
<FONT color="green">1268</FONT>             * @param value the value to be interpolated<a name="line.1268"></a>
<FONT color="green">1269</FONT>             * @return the interpolated value<a name="line.1269"></a>
<FONT color="green">1270</FONT>             */<a name="line.1270"></a>
<FONT color="green">1271</FONT>            @Override<a name="line.1271"></a>
<FONT color="green">1272</FONT>            protected Object interpolate(Object value)<a name="line.1272"></a>
<FONT color="green">1273</FONT>            {<a name="line.1273"></a>
<FONT color="green">1274</FONT>                return getConfigurationBuilder().interpolate(value);<a name="line.1274"></a>
<FONT color="green">1275</FONT>            }<a name="line.1275"></a>
<FONT color="green">1276</FONT>        }<a name="line.1276"></a>
<FONT color="green">1277</FONT>    <a name="line.1277"></a>
<FONT color="green">1278</FONT>        /**<a name="line.1278"></a>
<FONT color="green">1279</FONT>         * A specialized {@code BeanFactory} implementation that handles<a name="line.1279"></a>
<FONT color="green">1280</FONT>         * configuration declarations. This class will retrieve the correct<a name="line.1280"></a>
<FONT color="green">1281</FONT>         * configuration provider and delegate the task of creating the<a name="line.1281"></a>
<FONT color="green">1282</FONT>         * configuration to this object.<a name="line.1282"></a>
<FONT color="green">1283</FONT>         */<a name="line.1283"></a>
<FONT color="green">1284</FONT>        static class ConfigurationBeanFactory implements BeanFactory<a name="line.1284"></a>
<FONT color="green">1285</FONT>        {<a name="line.1285"></a>
<FONT color="green">1286</FONT>            /** The logger. */<a name="line.1286"></a>
<FONT color="green">1287</FONT>            private Log logger = LogFactory.getLog(DefaultConfigurationBuilder.class);<a name="line.1287"></a>
<FONT color="green">1288</FONT>    <a name="line.1288"></a>
<FONT color="green">1289</FONT>            /**<a name="line.1289"></a>
<FONT color="green">1290</FONT>             * Creates an instance of a bean class. This implementation expects that<a name="line.1290"></a>
<FONT color="green">1291</FONT>             * the passed in bean declaration is a declaration for a configuration.<a name="line.1291"></a>
<FONT color="green">1292</FONT>             * It will determine the responsible configuration provider and delegate<a name="line.1292"></a>
<FONT color="green">1293</FONT>             * the call to this instance. If creation of the configuration fails<a name="line.1293"></a>
<FONT color="green">1294</FONT>             * and the {@code optional} attribute is set, the exception will<a name="line.1294"></a>
<FONT color="green">1295</FONT>             * be ignored. If the {@code forceCreate} attribute is set, too,<a name="line.1295"></a>
<FONT color="green">1296</FONT>             * the provider is asked to create an empty configuration. A return<a name="line.1296"></a>
<FONT color="green">1297</FONT>             * value of &lt;b&gt;null&lt;/b&gt; means that no configuration could be created.<a name="line.1297"></a>
<FONT color="green">1298</FONT>             *<a name="line.1298"></a>
<FONT color="green">1299</FONT>             * @param beanClass the bean class (will be ignored)<a name="line.1299"></a>
<FONT color="green">1300</FONT>             * @param data the declaration<a name="line.1300"></a>
<FONT color="green">1301</FONT>             * @param param an additional parameter (will be ignored)<a name="line.1301"></a>
<FONT color="green">1302</FONT>             * @return the newly created configuration<a name="line.1302"></a>
<FONT color="green">1303</FONT>             * @throws Exception if an error occurs<a name="line.1303"></a>
<FONT color="green">1304</FONT>             */<a name="line.1304"></a>
<FONT color="green">1305</FONT>            public Object createBean(Class&lt;?&gt; beanClass, BeanDeclaration data,<a name="line.1305"></a>
<FONT color="green">1306</FONT>                    Object param) throws Exception<a name="line.1306"></a>
<FONT color="green">1307</FONT>            {<a name="line.1307"></a>
<FONT color="green">1308</FONT>                ConfigurationDeclaration decl = (ConfigurationDeclaration) data;<a name="line.1308"></a>
<FONT color="green">1309</FONT>                String tagName = decl.getNode().getName();<a name="line.1309"></a>
<FONT color="green">1310</FONT>                ConfigurationProvider provider = decl.getConfigurationBuilder()<a name="line.1310"></a>
<FONT color="green">1311</FONT>                        .providerForTag(tagName);<a name="line.1311"></a>
<FONT color="green">1312</FONT>                if (provider == null)<a name="line.1312"></a>
<FONT color="green">1313</FONT>                {<a name="line.1313"></a>
<FONT color="green">1314</FONT>                    throw new ConfigurationRuntimeException(<a name="line.1314"></a>
<FONT color="green">1315</FONT>                            "No ConfigurationProvider registered for tag "<a name="line.1315"></a>
<FONT color="green">1316</FONT>                                    + tagName);<a name="line.1316"></a>
<FONT color="green">1317</FONT>                }<a name="line.1317"></a>
<FONT color="green">1318</FONT>    <a name="line.1318"></a>
<FONT color="green">1319</FONT>                try<a name="line.1319"></a>
<FONT color="green">1320</FONT>                {<a name="line.1320"></a>
<FONT color="green">1321</FONT>                    AbstractConfiguration config = provider.getConfiguration(decl);<a name="line.1321"></a>
<FONT color="green">1322</FONT>                    installInterpolator(decl, config);<a name="line.1322"></a>
<FONT color="green">1323</FONT>                    return config;<a name="line.1323"></a>
<FONT color="green">1324</FONT>                }<a name="line.1324"></a>
<FONT color="green">1325</FONT>                catch (Exception ex)<a name="line.1325"></a>
<FONT color="green">1326</FONT>                {<a name="line.1326"></a>
<FONT color="green">1327</FONT>                    // If this is an optional configuration, ignore the exception<a name="line.1327"></a>
<FONT color="green">1328</FONT>                    if (!decl.isOptional())<a name="line.1328"></a>
<FONT color="green">1329</FONT>                    {<a name="line.1329"></a>
<FONT color="green">1330</FONT>                        throw ex;<a name="line.1330"></a>
<FONT color="green">1331</FONT>                    }<a name="line.1331"></a>
<FONT color="green">1332</FONT>                    else<a name="line.1332"></a>
<FONT color="green">1333</FONT>                    {<a name="line.1333"></a>
<FONT color="green">1334</FONT>                        if (logger.isDebugEnabled())<a name="line.1334"></a>
<FONT color="green">1335</FONT>                        {<a name="line.1335"></a>
<FONT color="green">1336</FONT>                            logger.debug("Load failed for optional configuration " + tagName + ": "<a name="line.1336"></a>
<FONT color="green">1337</FONT>                                + ex.getMessage());<a name="line.1337"></a>
<FONT color="green">1338</FONT>                        }<a name="line.1338"></a>
<FONT color="green">1339</FONT>                        // Notify registered error listeners<a name="line.1339"></a>
<FONT color="green">1340</FONT>                        decl.getConfigurationBuilder().fireError(<a name="line.1340"></a>
<FONT color="green">1341</FONT>                                EVENT_ERR_LOAD_OPTIONAL,<a name="line.1341"></a>
<FONT color="green">1342</FONT>                                decl.getConfiguration().getString(ATTR_NAME), null,<a name="line.1342"></a>
<FONT color="green">1343</FONT>                                ex);<a name="line.1343"></a>
<FONT color="green">1344</FONT>    <a name="line.1344"></a>
<FONT color="green">1345</FONT>                        if (decl.isForceCreate())<a name="line.1345"></a>
<FONT color="green">1346</FONT>                        {<a name="line.1346"></a>
<FONT color="green">1347</FONT>                            try<a name="line.1347"></a>
<FONT color="green">1348</FONT>                            {<a name="line.1348"></a>
<FONT color="green">1349</FONT>                                return provider.getEmptyConfiguration(decl);<a name="line.1349"></a>
<FONT color="green">1350</FONT>                            }<a name="line.1350"></a>
<FONT color="green">1351</FONT>                            catch (Exception ex2)<a name="line.1351"></a>
<FONT color="green">1352</FONT>                            {<a name="line.1352"></a>
<FONT color="green">1353</FONT>                                // Ignore exception, return null in this case<a name="line.1353"></a>
<FONT color="green">1354</FONT>                                logger.warn("Could not create instance of optional configuration "<a name="line.1354"></a>
<FONT color="green">1355</FONT>                                        + tagName, ex2);<a name="line.1355"></a>
<FONT color="green">1356</FONT>                            }<a name="line.1356"></a>
<FONT color="green">1357</FONT>                        }<a name="line.1357"></a>
<FONT color="green">1358</FONT>                        return null;<a name="line.1358"></a>
<FONT color="green">1359</FONT>                    }<a name="line.1359"></a>
<FONT color="green">1360</FONT>                }<a name="line.1360"></a>
<FONT color="green">1361</FONT>            }<a name="line.1361"></a>
<FONT color="green">1362</FONT>    <a name="line.1362"></a>
<FONT color="green">1363</FONT>            /**<a name="line.1363"></a>
<FONT color="green">1364</FONT>             * Returns the default class for this bean factory.<a name="line.1364"></a>
<FONT color="green">1365</FONT>             *<a name="line.1365"></a>
<FONT color="green">1366</FONT>             * @return the default class<a name="line.1366"></a>
<FONT color="green">1367</FONT>             */<a name="line.1367"></a>
<FONT color="green">1368</FONT>            public Class&lt;?&gt; getDefaultBeanClass()<a name="line.1368"></a>
<FONT color="green">1369</FONT>            {<a name="line.1369"></a>
<FONT color="green">1370</FONT>                // Here some valid class must be returned, otherwise BeanHelper<a name="line.1370"></a>
<FONT color="green">1371</FONT>                // will complain that the bean's class cannot be determined<a name="line.1371"></a>
<FONT color="green">1372</FONT>                return Configuration.class;<a name="line.1372"></a>
<FONT color="green">1373</FONT>            }<a name="line.1373"></a>
<FONT color="green">1374</FONT>    <a name="line.1374"></a>
<FONT color="green">1375</FONT>            /**<a name="line.1375"></a>
<FONT color="green">1376</FONT>             * Installs a specialized {@code ConfigurationInterpolator} on a newly<a name="line.1376"></a>
<FONT color="green">1377</FONT>             * created configuration which also takes the combined configuration<a name="line.1377"></a>
<FONT color="green">1378</FONT>             * created by the builder into account. With this<a name="line.1378"></a>
<FONT color="green">1379</FONT>             * {@code ConfigurationInterpolator} the interpolation facilities of<a name="line.1379"></a>
<FONT color="green">1380</FONT>             * this child configuration are extended to include all other<a name="line.1380"></a>
<FONT color="green">1381</FONT>             * configurations created by this builder.<a name="line.1381"></a>
<FONT color="green">1382</FONT>             *<a name="line.1382"></a>
<FONT color="green">1383</FONT>             * @param decl the {@code ConfigurationDeclaration}<a name="line.1383"></a>
<FONT color="green">1384</FONT>             * @param config the newly created configuration instance<a name="line.1384"></a>
<FONT color="green">1385</FONT>             */<a name="line.1385"></a>
<FONT color="green">1386</FONT>            private void installInterpolator(ConfigurationDeclaration decl,<a name="line.1386"></a>
<FONT color="green">1387</FONT>                    AbstractConfiguration config)<a name="line.1387"></a>
<FONT color="green">1388</FONT>            {<a name="line.1388"></a>
<FONT color="green">1389</FONT>                ConfigurationInterpolator parent = new ConfigurationInterpolator();<a name="line.1389"></a>
<FONT color="green">1390</FONT>                parent.setDefaultLookup(decl.getConfigurationBuilder().combinedConfigLookup);<a name="line.1390"></a>
<FONT color="green">1391</FONT>                config.getInterpolator().setParentInterpolator(parent);<a name="line.1391"></a>
<FONT color="green">1392</FONT>            }<a name="line.1392"></a>
<FONT color="green">1393</FONT>        }<a name="line.1393"></a>
<FONT color="green">1394</FONT>    <a name="line.1394"></a>
<FONT color="green">1395</FONT>        /**<a name="line.1395"></a>
<FONT color="green">1396</FONT>         * A specialized provider implementation that deals with file based<a name="line.1396"></a>
<FONT color="green">1397</FONT>         * configurations. Ensures that the base path is correctly set and that the<a name="line.1397"></a>
<FONT color="green">1398</FONT>         * load() method gets called.<a name="line.1398"></a>
<FONT color="green">1399</FONT>         */<a name="line.1399"></a>
<FONT color="green">1400</FONT>        public static class FileConfigurationProvider extends ConfigurationProvider<a name="line.1400"></a>
<FONT color="green">1401</FONT>        {<a name="line.1401"></a>
<FONT color="green">1402</FONT>            /**<a name="line.1402"></a>
<FONT color="green">1403</FONT>             * Creates a new instance of {@code FileConfigurationProvider}.<a name="line.1403"></a>
<FONT color="green">1404</FONT>             */<a name="line.1404"></a>
<FONT color="green">1405</FONT>            public FileConfigurationProvider()<a name="line.1405"></a>
<FONT color="green">1406</FONT>            {<a name="line.1406"></a>
<FONT color="green">1407</FONT>                super();<a name="line.1407"></a>
<FONT color="green">1408</FONT>            }<a name="line.1408"></a>
<FONT color="green">1409</FONT>    <a name="line.1409"></a>
<FONT color="green">1410</FONT>            /**<a name="line.1410"></a>
<FONT color="green">1411</FONT>             * Creates a new instance of {@code FileConfigurationProvider}<a name="line.1411"></a>
<FONT color="green">1412</FONT>             * and sets the configuration class.<a name="line.1412"></a>
<FONT color="green">1413</FONT>             *<a name="line.1413"></a>
<FONT color="green">1414</FONT>             * @param configClass the class for the configurations to be created<a name="line.1414"></a>
<FONT color="green">1415</FONT>             */<a name="line.1415"></a>
<FONT color="green">1416</FONT>            public FileConfigurationProvider(Class&lt;?&gt; configClass)<a name="line.1416"></a>
<FONT color="green">1417</FONT>            {<a name="line.1417"></a>
<FONT color="green">1418</FONT>                super(configClass);<a name="line.1418"></a>
<FONT color="green">1419</FONT>            }<a name="line.1419"></a>
<FONT color="green">1420</FONT>    <a name="line.1420"></a>
<FONT color="green">1421</FONT>            /**<a name="line.1421"></a>
<FONT color="green">1422</FONT>             * Creates a new instance of {@code FileConfigurationProvider}<a name="line.1422"></a>
<FONT color="green">1423</FONT>             * and sets the configuration class name.<a name="line.1423"></a>
<FONT color="green">1424</FONT>             *<a name="line.1424"></a>
<FONT color="green">1425</FONT>             * @param configClassName the name of the configuration to be created<a name="line.1425"></a>
<FONT color="green">1426</FONT>             * @since 1.4<a name="line.1426"></a>
<FONT color="green">1427</FONT>             */<a name="line.1427"></a>
<FONT color="green">1428</FONT>            public FileConfigurationProvider(String configClassName)<a name="line.1428"></a>
<FONT color="green">1429</FONT>            {<a name="line.1429"></a>
<FONT color="green">1430</FONT>                super(configClassName);<a name="line.1430"></a>
<FONT color="green">1431</FONT>            }<a name="line.1431"></a>
<FONT color="green">1432</FONT>    <a name="line.1432"></a>
<FONT color="green">1433</FONT>            /**<a name="line.1433"></a>
<FONT color="green">1434</FONT>             * Creates the configuration. After that {@code load()} will be<a name="line.1434"></a>
<FONT color="green">1435</FONT>             * called. If this configuration is marked as optional, exceptions will<a name="line.1435"></a>
<FONT color="green">1436</FONT>             * be ignored.<a name="line.1436"></a>
<FONT color="green">1437</FONT>             *<a name="line.1437"></a>
<FONT color="green">1438</FONT>             * @param decl the declaration<a name="line.1438"></a>
<FONT color="green">1439</FONT>             * @return the new configuration<a name="line.1439"></a>
<FONT color="green">1440</FONT>             * @throws Exception if an error occurs<a name="line.1440"></a>
<FONT color="green">1441</FONT>             */<a name="line.1441"></a>
<FONT color="green">1442</FONT>            @Override<a name="line.1442"></a>
<FONT color="green">1443</FONT>            public AbstractConfiguration getConfiguration(<a name="line.1443"></a>
<FONT color="green">1444</FONT>                    ConfigurationDeclaration decl) throws Exception<a name="line.1444"></a>
<FONT color="green">1445</FONT>            {<a name="line.1445"></a>
<FONT color="green">1446</FONT>                AbstractConfiguration result = getEmptyConfiguration(decl);<a name="line.1446"></a>
<FONT color="green">1447</FONT>                if (result instanceof FileSystemBased)<a name="line.1447"></a>
<FONT color="green">1448</FONT>                {<a name="line.1448"></a>
<FONT color="green">1449</FONT>                    DefaultConfigurationBuilder builder = decl.getConfigurationBuilder();<a name="line.1449"></a>
<FONT color="green">1450</FONT>                    if (builder.getFileSystem() != null)<a name="line.1450"></a>
<FONT color="green">1451</FONT>                    {<a name="line.1451"></a>
<FONT color="green">1452</FONT>                        ((FileSystemBased) result).setFileSystem(builder.getFileSystem());<a name="line.1452"></a>
<FONT color="green">1453</FONT>                    }<a name="line.1453"></a>
<FONT color="green">1454</FONT>                }<a name="line.1454"></a>
<FONT color="green">1455</FONT>                ((FileConfiguration) result).load();<a name="line.1455"></a>
<FONT color="green">1456</FONT>                return result;<a name="line.1456"></a>
<FONT color="green">1457</FONT>            }<a name="line.1457"></a>
<FONT color="green">1458</FONT>    <a name="line.1458"></a>
<FONT color="green">1459</FONT>            /**<a name="line.1459"></a>
<FONT color="green">1460</FONT>             * Returns an uninitialized file configuration. This method will be<a name="line.1460"></a>
<FONT color="green">1461</FONT>             * called for optional configurations when the<a name="line.1461"></a>
<FONT color="green">1462</FONT>             * {@code getConfiguration()} method caused an error and the<a name="line.1462"></a>
<FONT color="green">1463</FONT>             * {@code forceCreate} attribute is set. It will create the<a name="line.1463"></a>
<FONT color="green">1464</FONT>             * configuration of the represented type, but the {@code load()}<a name="line.1464"></a>
<FONT color="green">1465</FONT>             * method won't be called. This way non-existing configuration files can<a name="line.1465"></a>
<FONT color="green">1466</FONT>             * be handled gracefully: If loading a the file fails, an empty<a name="line.1466"></a>
<FONT color="green">1467</FONT>             * configuration will be created that is already configured with the<a name="line.1467"></a>
<FONT color="green">1468</FONT>             * correct file name.<a name="line.1468"></a>
<FONT color="green">1469</FONT>             *<a name="line.1469"></a>
<FONT color="green">1470</FONT>             * @param decl the bean declaration with initialization parameters for<a name="line.1470"></a>
<FONT color="green">1471</FONT>             * the configuration<a name="line.1471"></a>
<FONT color="green">1472</FONT>             * @return the new configuration object<a name="line.1472"></a>
<FONT color="green">1473</FONT>             * @throws Exception if an error occurs<a name="line.1473"></a>
<FONT color="green">1474</FONT>             * @since 1.4<a name="line.1474"></a>
<FONT color="green">1475</FONT>             */<a name="line.1475"></a>
<FONT color="green">1476</FONT>            @Override<a name="line.1476"></a>
<FONT color="green">1477</FONT>            public AbstractConfiguration getEmptyConfiguration(<a name="line.1477"></a>
<FONT color="green">1478</FONT>                    ConfigurationDeclaration decl) throws Exception<a name="line.1478"></a>
<FONT color="green">1479</FONT>            {<a name="line.1479"></a>
<FONT color="green">1480</FONT>                AbstractConfiguration config = super.getConfiguration(decl);<a name="line.1480"></a>
<FONT color="green">1481</FONT>    <a name="line.1481"></a>
<FONT color="green">1482</FONT>                /**<a name="line.1482"></a>
<FONT color="green">1483</FONT>                 * Some wrapper classes may need to pass the EntityResolver to XMLConfigurations<a name="line.1483"></a>
<FONT color="green">1484</FONT>                 * they construct buy may not be an XMLConfiguration.<a name="line.1484"></a>
<FONT color="green">1485</FONT>                 */<a name="line.1485"></a>
<FONT color="green">1486</FONT>                if (config instanceof EntityResolverSupport)<a name="line.1486"></a>
<FONT color="green">1487</FONT>                {<a name="line.1487"></a>
<FONT color="green">1488</FONT>                    DefaultConfigurationBuilder builder = decl.getConfigurationBuilder();<a name="line.1488"></a>
<FONT color="green">1489</FONT>                    EntityResolver resolver = builder.getEntityResolver();<a name="line.1489"></a>
<FONT color="green">1490</FONT>                    ((EntityResolverSupport) config).setEntityResolver(resolver);<a name="line.1490"></a>
<FONT color="green">1491</FONT>                }<a name="line.1491"></a>
<FONT color="green">1492</FONT>    <a name="line.1492"></a>
<FONT color="green">1493</FONT>                return config;<a name="line.1493"></a>
<FONT color="green">1494</FONT>            }<a name="line.1494"></a>
<FONT color="green">1495</FONT>    <a name="line.1495"></a>
<FONT color="green">1496</FONT>            /**<a name="line.1496"></a>
<FONT color="green">1497</FONT>             * Initializes the bean instance. Ensures that the file configuration's<a name="line.1497"></a>
<FONT color="green">1498</FONT>             * base path will be initialized with the base path of the factory so<a name="line.1498"></a>
<FONT color="green">1499</FONT>             * that relative path names can be correctly resolved.<a name="line.1499"></a>
<FONT color="green">1500</FONT>             *<a name="line.1500"></a>
<FONT color="green">1501</FONT>             * @param bean the bean to be initialized<a name="line.1501"></a>
<FONT color="green">1502</FONT>             * @param data the declaration<a name="line.1502"></a>
<FONT color="green">1503</FONT>             * @throws Exception if an error occurs<a name="line.1503"></a>
<FONT color="green">1504</FONT>             */<a name="line.1504"></a>
<FONT color="green">1505</FONT>            @Override<a name="line.1505"></a>
<FONT color="green">1506</FONT>            protected void initBeanInstance(Object bean, BeanDeclaration data)<a name="line.1506"></a>
<FONT color="green">1507</FONT>                    throws Exception<a name="line.1507"></a>
<FONT color="green">1508</FONT>            {<a name="line.1508"></a>
<FONT color="green">1509</FONT>                FileConfiguration config = (FileConfiguration) bean;<a name="line.1509"></a>
<FONT color="green">1510</FONT>                config.setBasePath(((ConfigurationDeclaration) data)<a name="line.1510"></a>
<FONT color="green">1511</FONT>                        .getConfigurationBuilder().getConfigurationBasePath());<a name="line.1511"></a>
<FONT color="green">1512</FONT>                super.initBeanInstance(bean, data);<a name="line.1512"></a>
<FONT color="green">1513</FONT>            }<a name="line.1513"></a>
<FONT color="green">1514</FONT>        }<a name="line.1514"></a>
<FONT color="green">1515</FONT>    <a name="line.1515"></a>
<FONT color="green">1516</FONT>        /**<a name="line.1516"></a>
<FONT color="green">1517</FONT>         * A specialized configuration provider for XML configurations. This<a name="line.1517"></a>
<FONT color="green">1518</FONT>         * implementation acts like a {@code FileConfigurationProvider}, but<a name="line.1518"></a>
<FONT color="green">1519</FONT>         * it will copy all entity IDs that have been registered for the<a name="line.1519"></a>
<FONT color="green">1520</FONT>         * configuration builder to the new XML configuration before it is loaded.<a name="line.1520"></a>
<FONT color="green">1521</FONT>         *<a name="line.1521"></a>
<FONT color="green">1522</FONT>         * @since 1.6<a name="line.1522"></a>
<FONT color="green">1523</FONT>         */<a name="line.1523"></a>
<FONT color="green">1524</FONT>        public static class XMLConfigurationProvider extends FileConfigurationProvider<a name="line.1524"></a>
<FONT color="green">1525</FONT>        {<a name="line.1525"></a>
<FONT color="green">1526</FONT>            /**<a name="line.1526"></a>
<FONT color="green">1527</FONT>             * Creates a new instance of {@code XMLConfigurationProvider}.<a name="line.1527"></a>
<FONT color="green">1528</FONT>             */<a name="line.1528"></a>
<FONT color="green">1529</FONT>            public XMLConfigurationProvider()<a name="line.1529"></a>
<FONT color="green">1530</FONT>            {<a name="line.1530"></a>
<FONT color="green">1531</FONT>                super(XMLConfiguration.class);<a name="line.1531"></a>
<FONT color="green">1532</FONT>            }<a name="line.1532"></a>
<FONT color="green">1533</FONT>    <a name="line.1533"></a>
<FONT color="green">1534</FONT>            /**<a name="line.1534"></a>
<FONT color="green">1535</FONT>             * Returns a new empty configuration instance. This implementation<a name="line.1535"></a>
<FONT color="green">1536</FONT>             * performs some additional initialization specific to XML<a name="line.1536"></a>
<FONT color="green">1537</FONT>             * configurations.<a name="line.1537"></a>
<FONT color="green">1538</FONT>             *<a name="line.1538"></a>
<FONT color="green">1539</FONT>             * @param decl the configuration declaration<a name="line.1539"></a>
<FONT color="green">1540</FONT>             * @return the new configuration<a name="line.1540"></a>
<FONT color="green">1541</FONT>             * @throws Exception if an error occurs<a name="line.1541"></a>
<FONT color="green">1542</FONT>             */<a name="line.1542"></a>
<FONT color="green">1543</FONT>            @Override<a name="line.1543"></a>
<FONT color="green">1544</FONT>            public AbstractConfiguration getEmptyConfiguration(<a name="line.1544"></a>
<FONT color="green">1545</FONT>                    ConfigurationDeclaration decl) throws Exception<a name="line.1545"></a>
<FONT color="green">1546</FONT>            {<a name="line.1546"></a>
<FONT color="green">1547</FONT>                XMLConfiguration config = (XMLConfiguration) super<a name="line.1547"></a>
<FONT color="green">1548</FONT>                        .getEmptyConfiguration(decl);<a name="line.1548"></a>
<FONT color="green">1549</FONT>    <a name="line.1549"></a>
<FONT color="green">1550</FONT>                DefaultConfigurationBuilder builder = decl<a name="line.1550"></a>
<FONT color="green">1551</FONT>                        .getConfigurationBuilder();<a name="line.1551"></a>
<FONT color="green">1552</FONT>                EntityResolver resolver = builder.getEntityResolver();<a name="line.1552"></a>
<FONT color="green">1553</FONT>                if (resolver instanceof EntityRegistry)<a name="line.1553"></a>
<FONT color="green">1554</FONT>                {<a name="line.1554"></a>
<FONT color="green">1555</FONT>                    // copy the registered entities<a name="line.1555"></a>
<FONT color="green">1556</FONT>                    config.getRegisteredEntities().putAll(<a name="line.1556"></a>
<FONT color="green">1557</FONT>                        builder.getRegisteredEntities());<a name="line.1557"></a>
<FONT color="green">1558</FONT>                }<a name="line.1558"></a>
<FONT color="green">1559</FONT>                else<a name="line.1559"></a>
<FONT color="green">1560</FONT>                {<a name="line.1560"></a>
<FONT color="green">1561</FONT>                    config.setEntityResolver(resolver);<a name="line.1561"></a>
<FONT color="green">1562</FONT>                }<a name="line.1562"></a>
<FONT color="green">1563</FONT>                return config;<a name="line.1563"></a>
<FONT color="green">1564</FONT>            }<a name="line.1564"></a>
<FONT color="green">1565</FONT>        }<a name="line.1565"></a>
<FONT color="green">1566</FONT>    <a name="line.1566"></a>
<FONT color="green">1567</FONT>        /**<a name="line.1567"></a>
<FONT color="green">1568</FONT>         * A specialized configuration provider for file based configurations that<a name="line.1568"></a>
<FONT color="green">1569</FONT>         * can handle configuration sources whose concrete type depends on the<a name="line.1569"></a>
<FONT color="green">1570</FONT>         * extension of the file to be loaded. One example is the<a name="line.1570"></a>
<FONT color="green">1571</FONT>         * {@code properties} tag: if the file ends with ".xml" a<a name="line.1571"></a>
<FONT color="green">1572</FONT>         * XMLPropertiesConfiguration object must be created, otherwise a<a name="line.1572"></a>
<FONT color="green">1573</FONT>         * PropertiesConfiguration object.<a name="line.1573"></a>
<FONT color="green">1574</FONT>         */<a name="line.1574"></a>
<FONT color="green">1575</FONT>        static class FileExtensionConfigurationProvider extends<a name="line.1575"></a>
<FONT color="green">1576</FONT>                FileConfigurationProvider<a name="line.1576"></a>
<FONT color="green">1577</FONT>        {<a name="line.1577"></a>
<FONT color="green">1578</FONT>            /**<a name="line.1578"></a>
<FONT color="green">1579</FONT>             * Stores the class to be created when the file extension matches.<a name="line.1579"></a>
<FONT color="green">1580</FONT>             */<a name="line.1580"></a>
<FONT color="green">1581</FONT>            private Class&lt;?&gt; matchingClass;<a name="line.1581"></a>
<FONT color="green">1582</FONT>    <a name="line.1582"></a>
<FONT color="green">1583</FONT>            /**<a name="line.1583"></a>
<FONT color="green">1584</FONT>             * Stores the name of the class to be created when the file extension<a name="line.1584"></a>
<FONT color="green">1585</FONT>             * matches.<a name="line.1585"></a>
<FONT color="green">1586</FONT>             */<a name="line.1586"></a>
<FONT color="green">1587</FONT>            private String matchingClassName;<a name="line.1587"></a>
<FONT color="green">1588</FONT>    <a name="line.1588"></a>
<FONT color="green">1589</FONT>            /**<a name="line.1589"></a>
<FONT color="green">1590</FONT>             * Stores the class to be created when the file extension does not<a name="line.1590"></a>
<FONT color="green">1591</FONT>             * match.<a name="line.1591"></a>
<FONT color="green">1592</FONT>             */<a name="line.1592"></a>
<FONT color="green">1593</FONT>            private Class&lt;?&gt; defaultClass;<a name="line.1593"></a>
<FONT color="green">1594</FONT>    <a name="line.1594"></a>
<FONT color="green">1595</FONT>            /**<a name="line.1595"></a>
<FONT color="green">1596</FONT>             * Stores the name of the class to be created when the file extension<a name="line.1596"></a>
<FONT color="green">1597</FONT>             * does not match.<a name="line.1597"></a>
<FONT color="green">1598</FONT>             */<a name="line.1598"></a>
<FONT color="green">1599</FONT>            private String defaultClassName;<a name="line.1599"></a>
<FONT color="green">1600</FONT>    <a name="line.1600"></a>
<FONT color="green">1601</FONT>            /** Stores the file extension to be checked against. */<a name="line.1601"></a>
<FONT color="green">1602</FONT>            private String fileExtension;<a name="line.1602"></a>
<FONT color="green">1603</FONT>    <a name="line.1603"></a>
<FONT color="green">1604</FONT>            /**<a name="line.1604"></a>
<FONT color="green">1605</FONT>             * Creates a new instance of<a name="line.1605"></a>
<FONT color="green">1606</FONT>             * {@code FileExtensionConfigurationProvider} and initializes it.<a name="line.1606"></a>
<FONT color="green">1607</FONT>             *<a name="line.1607"></a>
<FONT color="green">1608</FONT>             * @param matchingClass the class to be created when the file extension<a name="line.1608"></a>
<FONT color="green">1609</FONT>             * matches<a name="line.1609"></a>
<FONT color="green">1610</FONT>             * @param defaultClass the class to be created when the file extension<a name="line.1610"></a>
<FONT color="green">1611</FONT>             * does not match<a name="line.1611"></a>
<FONT color="green">1612</FONT>             * @param extension the file extension to be checked against<a name="line.1612"></a>
<FONT color="green">1613</FONT>             */<a name="line.1613"></a>
<FONT color="green">1614</FONT>            public FileExtensionConfigurationProvider(Class&lt;?&gt; matchingClass,<a name="line.1614"></a>
<FONT color="green">1615</FONT>                    Class&lt;?&gt; defaultClass, String extension)<a name="line.1615"></a>
<FONT color="green">1616</FONT>            {<a name="line.1616"></a>
<FONT color="green">1617</FONT>                this.matchingClass = matchingClass;<a name="line.1617"></a>
<FONT color="green">1618</FONT>                this.defaultClass = defaultClass;<a name="line.1618"></a>
<FONT color="green">1619</FONT>                fileExtension = extension;<a name="line.1619"></a>
<FONT color="green">1620</FONT>            }<a name="line.1620"></a>
<FONT color="green">1621</FONT>    <a name="line.1621"></a>
<FONT color="green">1622</FONT>            /**<a name="line.1622"></a>
<FONT color="green">1623</FONT>             * Creates a new instance of<a name="line.1623"></a>
<FONT color="green">1624</FONT>             * {@code FileExtensionConfigurationProvider} and initializes it<a name="line.1624"></a>
<FONT color="green">1625</FONT>             * with the names of the classes to be created.<a name="line.1625"></a>
<FONT color="green">1626</FONT>             *<a name="line.1626"></a>
<FONT color="green">1627</FONT>             * @param matchingClassName the name of the class to be created when the<a name="line.1627"></a>
<FONT color="green">1628</FONT>             * file extension matches<a name="line.1628"></a>
<FONT color="green">1629</FONT>             * @param defaultClassName the name of the class to be created when the<a name="line.1629"></a>
<FONT color="green">1630</FONT>             * file extension does not match<a name="line.1630"></a>
<FONT color="green">1631</FONT>             * @param extension the file extension to be checked against<a name="line.1631"></a>
<FONT color="green">1632</FONT>             * @since 1.4<a name="line.1632"></a>
<FONT color="green">1633</FONT>             */<a name="line.1633"></a>
<FONT color="green">1634</FONT>            public FileExtensionConfigurationProvider(String matchingClassName,<a name="line.1634"></a>
<FONT color="green">1635</FONT>                    String defaultClassName, String extension)<a name="line.1635"></a>
<FONT color="green">1636</FONT>            {<a name="line.1636"></a>
<FONT color="green">1637</FONT>                this.matchingClassName = matchingClassName;<a name="line.1637"></a>
<FONT color="green">1638</FONT>                this.defaultClassName = defaultClassName;<a name="line.1638"></a>
<FONT color="green">1639</FONT>                fileExtension = extension;<a name="line.1639"></a>
<FONT color="green">1640</FONT>            }<a name="line.1640"></a>
<FONT color="green">1641</FONT>    <a name="line.1641"></a>
<FONT color="green">1642</FONT>            /**<a name="line.1642"></a>
<FONT color="green">1643</FONT>             * Returns the matching class object, no matter whether it was defined<a name="line.1643"></a>
<FONT color="green">1644</FONT>             * as a class or as a class name.<a name="line.1644"></a>
<FONT color="green">1645</FONT>             *<a name="line.1645"></a>
<FONT color="green">1646</FONT>             * @return the matching class object<a name="line.1646"></a>
<FONT color="green">1647</FONT>             * @throws Exception if an error occurs<a name="line.1647"></a>
<FONT color="green">1648</FONT>             * @since 1.4<a name="line.1648"></a>
<FONT color="green">1649</FONT>             */<a name="line.1649"></a>
<FONT color="green">1650</FONT>            protected synchronized Class&lt;?&gt; fetchMatchingClass() throws Exception<a name="line.1650"></a>
<FONT color="green">1651</FONT>            {<a name="line.1651"></a>
<FONT color="green">1652</FONT>                if (matchingClass == null)<a name="line.1652"></a>
<FONT color="green">1653</FONT>                {<a name="line.1653"></a>
<FONT color="green">1654</FONT>                    matchingClass = loadClass(matchingClassName);<a name="line.1654"></a>
<FONT color="green">1655</FONT>                }<a name="line.1655"></a>
<FONT color="green">1656</FONT>                return matchingClass;<a name="line.1656"></a>
<FONT color="green">1657</FONT>            }<a name="line.1657"></a>
<FONT color="green">1658</FONT>    <a name="line.1658"></a>
<FONT color="green">1659</FONT>            /**<a name="line.1659"></a>
<FONT color="green">1660</FONT>             * Returns the default class object, no matter whether it was defined as<a name="line.1660"></a>
<FONT color="green">1661</FONT>             * a class or as a class name.<a name="line.1661"></a>
<FONT color="green">1662</FONT>             *<a name="line.1662"></a>
<FONT color="green">1663</FONT>             * @return the default class object<a name="line.1663"></a>
<FONT color="green">1664</FONT>             * @throws Exception if an error occurs<a name="line.1664"></a>
<FONT color="green">1665</FONT>             * @since 1.4<a name="line.1665"></a>
<FONT color="green">1666</FONT>             */<a name="line.1666"></a>
<FONT color="green">1667</FONT>            protected synchronized Class&lt;?&gt; fetchDefaultClass() throws Exception<a name="line.1667"></a>
<FONT color="green">1668</FONT>            {<a name="line.1668"></a>
<FONT color="green">1669</FONT>                if (defaultClass == null)<a name="line.1669"></a>
<FONT color="green">1670</FONT>                {<a name="line.1670"></a>
<FONT color="green">1671</FONT>                    defaultClass = loadClass(defaultClassName);<a name="line.1671"></a>
<FONT color="green">1672</FONT>                }<a name="line.1672"></a>
<FONT color="green">1673</FONT>                return defaultClass;<a name="line.1673"></a>
<FONT color="green">1674</FONT>            }<a name="line.1674"></a>
<FONT color="green">1675</FONT>    <a name="line.1675"></a>
<FONT color="green">1676</FONT>            /**<a name="line.1676"></a>
<FONT color="green">1677</FONT>             * Creates the configuration object. The class is determined by the file<a name="line.1677"></a>
<FONT color="green">1678</FONT>             * name's extension.<a name="line.1678"></a>
<FONT color="green">1679</FONT>             *<a name="line.1679"></a>
<FONT color="green">1680</FONT>             * @param beanClass the class<a name="line.1680"></a>
<FONT color="green">1681</FONT>             * @param data the bean declaration<a name="line.1681"></a>
<FONT color="green">1682</FONT>             * @return the new bean<a name="line.1682"></a>
<FONT color="green">1683</FONT>             * @throws Exception if an error occurs<a name="line.1683"></a>
<FONT color="green">1684</FONT>             */<a name="line.1684"></a>
<FONT color="green">1685</FONT>            @Override<a name="line.1685"></a>
<FONT color="green">1686</FONT>            protected Object createBeanInstance(Class&lt;?&gt; beanClass,<a name="line.1686"></a>
<FONT color="green">1687</FONT>                    BeanDeclaration data) throws Exception<a name="line.1687"></a>
<FONT color="green">1688</FONT>            {<a name="line.1688"></a>
<FONT color="green">1689</FONT>                String fileName = ((ConfigurationDeclaration) data)<a name="line.1689"></a>
<FONT color="green">1690</FONT>                        .getConfiguration().getString(ATTR_FILENAME);<a name="line.1690"></a>
<FONT color="green">1691</FONT>                if (fileName != null<a name="line.1691"></a>
<FONT color="green">1692</FONT>                        &amp;&amp; fileName.toLowerCase().trim().endsWith(fileExtension))<a name="line.1692"></a>
<FONT color="green">1693</FONT>                {<a name="line.1693"></a>
<FONT color="green">1694</FONT>                    return super.createBeanInstance(fetchMatchingClass(), data);<a name="line.1694"></a>
<FONT color="green">1695</FONT>                }<a name="line.1695"></a>
<FONT color="green">1696</FONT>                else<a name="line.1696"></a>
<FONT color="green">1697</FONT>                {<a name="line.1697"></a>
<FONT color="green">1698</FONT>                    return super.createBeanInstance(fetchDefaultClass(), data);<a name="line.1698"></a>
<FONT color="green">1699</FONT>                }<a name="line.1699"></a>
<FONT color="green">1700</FONT>            }<a name="line.1700"></a>
<FONT color="green">1701</FONT>        }<a name="line.1701"></a>
<FONT color="green">1702</FONT>    <a name="line.1702"></a>
<FONT color="green">1703</FONT>        /**<a name="line.1703"></a>
<FONT color="green">1704</FONT>         * A specialized configuration provider class that allows to include other<a name="line.1704"></a>
<FONT color="green">1705</FONT>         * configuration definition files.<a name="line.1705"></a>
<FONT color="green">1706</FONT>         */<a name="line.1706"></a>
<FONT color="green">1707</FONT>        static class ConfigurationBuilderProvider extends ConfigurationProvider<a name="line.1707"></a>
<FONT color="green">1708</FONT>        {<a name="line.1708"></a>
<FONT color="green">1709</FONT>            /**<a name="line.1709"></a>
<FONT color="green">1710</FONT>             * Creates a new instance of {@code ConfigurationBuilderProvider}.<a name="line.1710"></a>
<FONT color="green">1711</FONT>             */<a name="line.1711"></a>
<FONT color="green">1712</FONT>            public ConfigurationBuilderProvider()<a name="line.1712"></a>
<FONT color="green">1713</FONT>            {<a name="line.1713"></a>
<FONT color="green">1714</FONT>                super(DefaultConfigurationBuilder.class);<a name="line.1714"></a>
<FONT color="green">1715</FONT>            }<a name="line.1715"></a>
<FONT color="green">1716</FONT>    <a name="line.1716"></a>
<FONT color="green">1717</FONT>            /**<a name="line.1717"></a>
<FONT color="green">1718</FONT>             * Creates the configuration. First creates a configuration builder<a name="line.1718"></a>
<FONT color="green">1719</FONT>             * object. Then returns the configuration created by this builder.<a name="line.1719"></a>
<FONT color="green">1720</FONT>             *<a name="line.1720"></a>
<FONT color="green">1721</FONT>             * @param decl the configuration declaration<a name="line.1721"></a>
<FONT color="green">1722</FONT>             * @return the configuration<a name="line.1722"></a>
<FONT color="green">1723</FONT>             * @exception Exception if an error occurs<a name="line.1723"></a>
<FONT color="green">1724</FONT>             */<a name="line.1724"></a>
<FONT color="green">1725</FONT>            @Override<a name="line.1725"></a>
<FONT color="green">1726</FONT>            public AbstractConfiguration getConfiguration(<a name="line.1726"></a>
<FONT color="green">1727</FONT>                    ConfigurationDeclaration decl) throws Exception<a name="line.1727"></a>
<FONT color="green">1728</FONT>            {<a name="line.1728"></a>
<FONT color="green">1729</FONT>                DefaultConfigurationBuilder builder = (DefaultConfigurationBuilder) super<a name="line.1729"></a>
<FONT color="green">1730</FONT>                        .getConfiguration(decl);<a name="line.1730"></a>
<FONT color="green">1731</FONT>                return builder.getConfiguration(true);<a name="line.1731"></a>
<FONT color="green">1732</FONT>            }<a name="line.1732"></a>
<FONT color="green">1733</FONT>    <a name="line.1733"></a>
<FONT color="green">1734</FONT>            /**<a name="line.1734"></a>
<FONT color="green">1735</FONT>             * Returns an empty configuration in case of an optional configuration<a name="line.1735"></a>
<FONT color="green">1736</FONT>             * could not be created. This implementation returns an empty combined<a name="line.1736"></a>
<FONT color="green">1737</FONT>             * configuration.<a name="line.1737"></a>
<FONT color="green">1738</FONT>             *<a name="line.1738"></a>
<FONT color="green">1739</FONT>             * @param decl the configuration declaration<a name="line.1739"></a>
<FONT color="green">1740</FONT>             * @return the configuration<a name="line.1740"></a>
<FONT color="green">1741</FONT>             * @exception Exception if an error occurs<a name="line.1741"></a>
<FONT color="green">1742</FONT>             * @since 1.4<a name="line.1742"></a>
<FONT color="green">1743</FONT>             */<a name="line.1743"></a>
<FONT color="green">1744</FONT>            @Override<a name="line.1744"></a>
<FONT color="green">1745</FONT>            public AbstractConfiguration getEmptyConfiguration(<a name="line.1745"></a>
<FONT color="green">1746</FONT>                    ConfigurationDeclaration decl) throws Exception<a name="line.1746"></a>
<FONT color="green">1747</FONT>            {<a name="line.1747"></a>
<FONT color="green">1748</FONT>                return new CombinedConfiguration();<a name="line.1748"></a>
<FONT color="green">1749</FONT>            }<a name="line.1749"></a>
<FONT color="green">1750</FONT>    <a name="line.1750"></a>
<FONT color="green">1751</FONT>            /**<a name="line.1751"></a>
<FONT color="green">1752</FONT>             * {@inheritDoc} This implementation ensures that the configuration<a name="line.1752"></a>
<FONT color="green">1753</FONT>             * builder created by this provider inherits the properties from the<a name="line.1753"></a>
<FONT color="green">1754</FONT>             * current configuration builder.<a name="line.1754"></a>
<FONT color="green">1755</FONT>             */<a name="line.1755"></a>
<FONT color="green">1756</FONT>            @Override<a name="line.1756"></a>
<FONT color="green">1757</FONT>            protected void initBeanInstance(Object bean, BeanDeclaration data)<a name="line.1757"></a>
<FONT color="green">1758</FONT>                    throws Exception<a name="line.1758"></a>
<FONT color="green">1759</FONT>            {<a name="line.1759"></a>
<FONT color="green">1760</FONT>                ConfigurationDeclaration decl = (ConfigurationDeclaration) data;<a name="line.1760"></a>
<FONT color="green">1761</FONT>                initChildBuilder(decl.getConfigurationBuilder(),<a name="line.1761"></a>
<FONT color="green">1762</FONT>                        (DefaultConfigurationBuilder) bean);<a name="line.1762"></a>
<FONT color="green">1763</FONT>                super.initBeanInstance(bean, data);<a name="line.1763"></a>
<FONT color="green">1764</FONT>            }<a name="line.1764"></a>
<FONT color="green">1765</FONT>    <a name="line.1765"></a>
<FONT color="green">1766</FONT>            /**<a name="line.1766"></a>
<FONT color="green">1767</FONT>             * Initializes the given child configuration builder from its parent<a name="line.1767"></a>
<FONT color="green">1768</FONT>             * builder. This method copies the values of some properties from the<a name="line.1768"></a>
<FONT color="green">1769</FONT>             * parent builder to the child builder so that the child inherits<a name="line.1769"></a>
<FONT color="green">1770</FONT>             * properties from its parent.<a name="line.1770"></a>
<FONT color="green">1771</FONT>             *<a name="line.1771"></a>
<FONT color="green">1772</FONT>             * @param parent the parent builder<a name="line.1772"></a>
<FONT color="green">1773</FONT>             * @param child the child builder<a name="line.1773"></a>
<FONT color="green">1774</FONT>             */<a name="line.1774"></a>
<FONT color="green">1775</FONT>            private static void initChildBuilder(<a name="line.1775"></a>
<FONT color="green">1776</FONT>                    DefaultConfigurationBuilder parent,<a name="line.1776"></a>
<FONT color="green">1777</FONT>                    DefaultConfigurationBuilder child)<a name="line.1777"></a>
<FONT color="green">1778</FONT>            {<a name="line.1778"></a>
<FONT color="green">1779</FONT>                child.setAttributeSplittingDisabled(parent<a name="line.1779"></a>
<FONT color="green">1780</FONT>                        .isAttributeSplittingDisabled());<a name="line.1780"></a>
<FONT color="green">1781</FONT>                child.setBasePath(parent.getBasePath());<a name="line.1781"></a>
<FONT color="green">1782</FONT>                child.setDelimiterParsingDisabled(parent<a name="line.1782"></a>
<FONT color="green">1783</FONT>                        .isDelimiterParsingDisabled());<a name="line.1783"></a>
<FONT color="green">1784</FONT>                child.setListDelimiter(parent.getListDelimiter());<a name="line.1784"></a>
<FONT color="green">1785</FONT>                child.setThrowExceptionOnMissing(parent.isThrowExceptionOnMissing());<a name="line.1785"></a>
<FONT color="green">1786</FONT>                child.setLogger(parent.getLogger());<a name="line.1786"></a>
<FONT color="green">1787</FONT>    <a name="line.1787"></a>
<FONT color="green">1788</FONT>                child.clearConfigurationListeners();<a name="line.1788"></a>
<FONT color="green">1789</FONT>                for (ConfigurationListener l : parent.getConfigurationListeners())<a name="line.1789"></a>
<FONT color="green">1790</FONT>                {<a name="line.1790"></a>
<FONT color="green">1791</FONT>                    child.addConfigurationListener(l);<a name="line.1791"></a>
<FONT color="green">1792</FONT>                }<a name="line.1792"></a>
<FONT color="green">1793</FONT>                child.clearErrorListeners();<a name="line.1793"></a>
<FONT color="green">1794</FONT>                for (ConfigurationErrorListener l : parent.getErrorListeners())<a name="line.1794"></a>
<FONT color="green">1795</FONT>                {<a name="line.1795"></a>
<FONT color="green">1796</FONT>                    child.addErrorListener(l);<a name="line.1796"></a>
<FONT color="green">1797</FONT>                }<a name="line.1797"></a>
<FONT color="green">1798</FONT>            }<a name="line.1798"></a>
<FONT color="green">1799</FONT>        }<a name="line.1799"></a>
<FONT color="green">1800</FONT>    }<a name="line.1800"></a>




























































</PRE>
</BODY>
</HTML>
